Update RandomSampler docstring. data_source must be Sized not Dataset (#158857)

Fixes #158631

The docstring said data_source was a Dataset, but RandomSampler only needs something that implements __len__. This updates the docstring to use Sized instead, which matches the actual type used in the constructor.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/158857
Approved by: https://github.com/divyanshk
This commit is contained in:
dsashidh
2025-09-20 04:05:22 +00:00
committed by PyTorch MergeBot
parent e56dd5d770
commit a87aea03f7

View File

@ -111,7 +111,7 @@ class SequentialSampler(Sampler[int]):
r"""Samples elements sequentially, always in the same order.
Args:
data_source (Dataset): dataset to sample from
data_source (Sized): data source to sample from. Must implement __len__.
"""
data_source: Sized
@ -132,7 +132,7 @@ class RandomSampler(Sampler[int]):
If with replacement, then user can specify :attr:`num_samples` to draw.
Args:
data_source (Dataset): dataset to sample from
data_source (Sized): data source to sample from. Must implement __len__.
replacement (bool): samples are drawn on-demand with replacement if ``True``, default=``False``
num_samples (int): number of samples to draw, default=`len(dataset)`.
generator (Generator): Generator used in sampling.