add new torchdata.nodes doc file #1390
Conversation
facebook-github-bot
added
the
CLA Signed
docs/source/torchdata.nodes.rst
Outdated
|
|
||
| torchdata.nodes adds more flexibility to the standard torch.utils.data offering, and introduces multi-threaded parallelism in addition to multi-process (the only supported approach in torch.utils.data.DataLoader), as well as first-class support for mid-epoch checkpointing through a state_dict/load_state_dict interface. | ||
|
|
||
| More information on torchdata.nodes can be found in the `README <https://github.com/pytorch/data/blob/main/torchdata/nodes/README.md>`_. |
There was a problem hiding this comment.
Should we flip it and have README point here, and copy/paste most of the README here?
There was a problem hiding this comment.
yeah lets do that, let's keep it in both places for now ?
i'll also edit the main readme to include a section on nodes
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/data/1390
Note: Links to docs will display an error until the docs builds have been completed. ❗ 1 Active SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below: ✅ No FailuresAs of commit 32ee5f7 with merge base aaeb157 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
Maybe for Tutorials/Examples we can have "Coming soon" or something for torchdata.nodes |
|
@andrewkho Would it look a little off if we had a mostly empty page for "Tutorials and Examples > torchdata.nodes". If feel we can just add the page when we have the tutorial ready (which I believe is fairly soon). What say ? I'll land this diff without it, but if you think we should add an empty page with "Coming soon!" do let me know, I'll create another PR. Also. I will add a note on tutorial coming soon in the overall README.md, so atleast that information is conveyed. |
* add new torchdata.nodes doc file * update main readme.md, move content of nodes readme.md to torchdata.nodes.rst * main readme * udpate readme
Clone the repo on local, created the environment, updated the
/docsfolder, thenmake htmlandsphinx-serve -b build.