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

update datamodule doc

Browse Source
This commit is contained in:
Dario Coscia
2025-03-17 13:25:56 +01:00
committed by Nicola Demo
parent 68583b567e
commit 43117fcc62
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
pina/data/data_module.py
View File

@@ -231,7 +231,7 @@ class PinaSampler:
:param PinaDataset dataset: The dataset from which to sample. :param PinaDataset dataset: The dataset from which to sample.
:param bool shuffle: Whether to shuffle the dataset. :param bool shuffle: Whether to shuffle the dataset.
:return: The sampler instance. :return: The sampler instance.
:rtype: torch.utils.data.Sampler :rtype: :class:`torch.utils.data.Sampler`
""" """
if ( if (
@@ -278,11 +278,11 @@ class PinaDataModule(LightningDataModule):
be in the range [0, 1]. be in the range [0, 1].
:param float val_size: Fraction of elements in the validation split. It :param float val_size: Fraction of elements in the validation split. It
must be in the range [0, 1]. must be in the range [0, 1].
:param batch_size: The batch size used for training. If ``None``, the :param int batch_size: The batch size used for training. If ``None``,
entire dataset is returned in a single batch. Default is ``None``. the entire dataset is returned in a single batch.
:type batch_size: int Default is ``None``.
:param bool shuffle: Whether to shuffle the dataset before splitting. :param bool shuffle: Whether to shuffle the dataset before splitting.
Default ``Tru``e. Default ``True``.
:param bool repeat: Whether to repeat the dataset indefinitely. :param bool repeat: Whether to repeat the dataset indefinitely.
Default ``False``. Default ``False``.
:param automatic_batching: Whether to enable automatic batching. :param automatic_batching: Whether to enable automatic batching.