Skip to content

Commit c5bd22a

Browse files
committed
update datamodule doc
1 parent 12fc1e5 commit c5bd22a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pina/data/data_module.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ def __new__(cls, dataset, shuffle):
231231
:param PinaDataset dataset: The dataset from which to sample.
232232
:param bool shuffle: Whether to shuffle the dataset.
233233
:return: The sampler instance.
234-
:rtype: torch.utils.data.Sampler
234+
:rtype: :class:`torch.utils.data.Sampler`
235235
"""
236236

237237
if (
@@ -278,11 +278,11 @@ def __init__(
278278
be in the range [0, 1].
279279
:param float val_size: Fraction of elements in the validation split. It
280280
must be in the range [0, 1].
281-
:param batch_size: The batch size used for training. If ``None``, the
282-
entire dataset is returned in a single batch. Default is ``None``.
283-
:type batch_size: int
281+
:param int batch_size: The batch size used for training. If ``None``,
282+
the entire dataset is returned in a single batch.
283+
Default is ``None``.
284284
:param bool shuffle: Whether to shuffle the dataset before splitting.
285-
Default ``Tru``e.
285+
Default ``True``.
286286
:param bool repeat: Whether to repeat the dataset indefinitely.
287287
Default ``False``.
288288
:param automatic_batching: Whether to enable automatic batching.

0 commit comments

Comments
 (0)