Skip to content

Commit 78061d2

Browse files
authored
Fix docstring in DatasetDict::shuffle (#4344)
1 parent 08ec04c commit 78061d2

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/datasets/dataset_dict.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -971,7 +971,7 @@ def shuffle(
971971
If None, then fresh, unpredictable entropy will be pulled from the OS.
972972
If an int or array_like[ints] is passed, then it will be passed to SeedSequence to derive the initial BitGenerator state.
973973
You can provide one :obj:`seed` per dataset in the dataset dictionary.
974-
seed (Optional `int`): A seed to initialize the default BitGenerator if ``generator=None``. Alias for seeds (the seed argument has priority over seeds if both arguments are provided).
974+
seed (Optional `int`): A seed to initialize the default BitGenerator if ``generator=None``. Alias for seeds (a `ValueError` is raised if both are provided).
975975
generators (Optional `Dict[str, np.random.Generator]`): Numpy random Generator to use to compute the permutation of the dataset rows.
976976
If ``generator=None`` (default), uses np.random.default_rng (the default BitGenerator (PCG64) of NumPy).
977977
You have to provide one :obj:`generator` per dataset in the dataset dictionary.

0 commit comments

Comments
 (0)