folivo/PINA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor update

Browse Source
This commit is contained in:
FilippoOlivo
2025-03-12 10:30:42 +01:00
parent 2cbc57ccbe
commit c6c2361899
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
pina/data/data_module.py
View File

@@ -287,14 +287,19 @@ class PinaDataModule(LightningDataModule):
:param automatic_batching: Whether to enable automatic batching. :param automatic_batching: Whether to enable automatic batching.
Default False. Default False.
:param int num_workers: Number of worker threads for data loading. :param int num_workers: Number of worker threads for data loading.
Default 0 (serial loading). For more information, see Default 0 (serial loading).
https://pytorch.org/docs/stable/data.html#multi-process-data-loading
:param bool pin_memory: Whether to use pinned memory for faster data :param bool pin_memory: Whether to use pinned memory for faster data
transfer to GPU. (Default False). For more information, see transfer to GPU. (Default False).
https://pytorch.org/docs/stable/data.html#memory-pinning
:raises ValueError: If at least one of the splits is negative. :raises ValueError: If at least one of the splits is negative.
:raises ValueError: If the sum of the splits is different from 1. :raises ValueError: If the sum of the splits is different from 1.
.. seealso::
For more information on multi-process data loading, see:
https://pytorch.org/docs/stable/data.html#multi-process-data-loading
For details on memory pinning, see:
https://pytorch.org/docs/stable/data.html#memory-pinning
""" """
super().__init__() super().__init__()