Modify inline doc for DataPipe (#64221)
authorErjia Guan <erjia@fb.com>
Tue, 31 Aug 2021 01:41:08 +0000 (18:41 -0700)
committerFacebook GitHub Bot <facebook-github-bot@users.noreply.github.com>
Tue, 31 Aug 2021 01:45:46 +0000 (18:45 -0700)
commita49907f984670781a718ef6aa0046709886eae5a
tree1428180199a25aa06e6999acb71fd3ffab731de0
parentaf85bc5ffd1d4ad52e0fed255aa7afe2fdfbc5e2
Modify inline doc for DataPipe (#64221)

Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/64221

List of tasks in this PR
- [x]  Add inline doc for DataPipe
- [x] Improve the inline doc
- [x] Expose DataPipe to `datapipes.iter` (`UnBatcher`) Note: `Forker`, `Demux`, `Mux` are exposed in another PR authored by Kevin
- [x] Add correct typing to DataPipe
- [x] Unify the argument to `datapipe` rather than `source_datapipe`

Test Plan: Imported from OSS

Reviewed By: VitalyFedyunin

Differential Revision: D30650541

Pulled By: ejguan

fbshipit-source-id: c09d1b9742b8097d8e645c15947cef80c876877b
15 files changed:
torch/utils/data/datapipes/iter/__init__.py
torch/utils/data/datapipes/iter/callable.py
torch/utils/data/datapipes/iter/combinatorics.py
torch/utils/data/datapipes/iter/combining.py
torch/utils/data/datapipes/iter/filelister.py
torch/utils/data/datapipes/iter/fileloader.py
torch/utils/data/datapipes/iter/grouping.py
torch/utils/data/datapipes/iter/httpreader.py
torch/utils/data/datapipes/iter/linereader.py
torch/utils/data/datapipes/iter/routeddecoder.py
torch/utils/data/datapipes/iter/selecting.py
torch/utils/data/datapipes/iter/streamreader.py
torch/utils/data/datapipes/iter/tararchivereader.py
torch/utils/data/datapipes/iter/utils.py
torch/utils/data/datapipes/iter/ziparchivereader.py