Attention

June 2024 Status Update: Removing DataPipes and DataLoader V2

We are re-focusing the torchdata repo to be an iterative enhancement of torch.utils.data.DataLoader. We do not plan on continuing development or maintaining the [DataPipes] and [DataLoaderV2] solutions, and they will be removed from the torchdata repo. We’ll also be revisiting the DataPipes references in pytorch/pytorch. In release torchdata==0.8.0 (July 2024) they will be marked as deprecated, and in 0.9.0 (Oct 2024) they will be deleted. Existing users are advised to pin to torchdata==0.8.0 or an older version until they are able to migrate away. Subsequent releases will not include DataPipes or DataLoaderV2. Please reach out if you suggestions or comments (please use this issue for feedback)

FileLister

class torchdata.datapipes.iter.FileLister(root: Union[str, Sequence[str], IterDataPipe] = '.', masks: Union[str, List[str]] = '', *, recursive: bool = False, abspath: bool = False, non_deterministic: bool = False, length: int = - 1)

Given path(s) to the root directory, yields file pathname(s) (path + filename) of files within the root directory.

Multiple root directories can be provided (functional name: list_files).

Parameters:

• root – Root directory or a sequence of root directories

• masks – Unix style filter string or string list for filtering file name(s)

• recursive – Whether to return pathname from nested directories or not

• abspath – Whether to return relative pathname or absolute pathname

• non_deterministic – Whether to return pathname in sorted order or not. If False, the results yielded from each root directory will be sorted

• length – Nominal length of the datapipe

Example

>>> # xdoctest: +SKIP
>>> from torchdata.datapipes.iter import FileLister
>>> dp = FileLister(root=".", recursive=True)
>>> list(dp)
['example.py', './data/data.tar']