Skip to content

Commit a964a83

Browse files
NivekTfacebook-github-bot
authored andcommitted
Adding documentation for utility functions (#205)
Summary: Pull Request resolved: #205 Setup documentation for utility function and added some links to PyTorch Core documentation. Let me know what else should be added here. Test Plan: Imported from OSS Reviewed By: VitalyFedyunin, ejguan Differential Revision: D34093684 Pulled By: NivekT fbshipit-source-id: b6e1a3c111570140c5a3ae8c6a5f0a4ec15d8303
1 parent 37bd84f commit a964a83

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

docs/source/torchdata.datapipes.iter.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ These DataPipes provide utility functions (e.g. caching, CSV parsing, filtering)
101101
InMemoryCacheHolder
102102
IndexAdder
103103
IoPathSaver
104-
IterDataPipe
105104
IterKeyZipper
106105
IterableWrapper
107106
JsonParser
Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
Utility Functions
22
===========================
33

4-
.. currentmodule:: torchdata.datapipes.util
4+
File Object and Stream Utility
5+
-------------------------------------
56

6-
Coming soon!
7+
.. currentmodule:: torchdata.datapipes.utils
8+
9+
.. autosummary::
10+
:nosignatures:
11+
:toctree: generated/
12+
:template: datapipe.rst
13+
14+
StreamWrapper
15+
16+
17+
DataLoader
18+
-------------------------------------
19+
20+
For documentation related to DataLoader, please refer to the
21+
``torch.utils.data`` `documentation <https://pytorch.org/docs/stable/data.html>`_. Or, more specifically, the
22+
`DataLoader API section <https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader>`_.
23+
24+
DataLoader v2 is currently in development. You should see an update here by mid-2022.
25+
26+
Sampler
27+
-------------------------------------
28+
29+
For documentation related to Sampler, please refer to the
30+
``torch.utils.data``
31+
`documentation on Data Loading order <https://pytorch.org/docs/stable/data.html#data-loading-order-and-sampler>`_.
32+
The Sampler API section is `here <https://pytorch.org/docs/stable/data.html#torch.utils.data.Sampler>`_.

0 commit comments

Comments
 (0)