Skip to content

Commit

Permalink
Fix S3 documentation (#542)
Browse files Browse the repository at this point in the history
Summary:
Per title

Pull Request resolved: #542

Reviewed By: VitalyFedyunin

Differential Revision: D37389586

Pulled By: ejguan

fbshipit-source-id: 7437ea488fb80b87e8f52b133c83d8990be8db02
  • Loading branch information
ejguan authored and facebook-github-bot committed Jun 24, 2022
1 parent 6c8f778 commit 4387ab4
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion torchdata/datapipes/iter/load/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Note: refer to the official documentation for detailed installtion instructions
Please refer to the documentation:

- [`S3FileLister`](https://pytorch.org/data/main/generated/torchdata.datapipes.iter.S3FileLister.html#s3filelister)
- [`S3FileLister`](https://pytorch.org/data/main/generated/torchdata.datapipes.iter.S3FileLoader.html#s3fileloader)
- [`S3FileLoader`](https://pytorch.org/data/main/generated/torchdata.datapipes.iter.S3FileLoader.html#s3fileloader)

### Note

Expand Down
2 changes: 1 addition & 1 deletion torchdata/datapipes/iter/load/s3io.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ class S3FileLoaderIterDataPipe(IterDataPipe[Tuple[str, StreamWrapper]]):
# https://pytorch.org/data/main/tutorial.html#working-with-dataloader
>>> sharded_s3_urls = dp_s3_urls.shuffle().sharding_filter()
>>> dp_s3_files = S3FileLoader(sharded_s3_urls)
>>> for url, fd in datapipe: # Start loading data
>>> for url, fd in dp_s3_files: # Start loading data
... data = fd.read()
# Functional API
>>> dp_s3_files = sharded_s3_urls.load_files_by_s3(buffer_size=256)
Expand Down

0 comments on commit 4387ab4

Please sign in to comment.