Skip to content

add new torchdata.nodes doc file#1390

Merged
divyanshk merged 4 commits intomainfrom
divyanshk/add-nodes-doc
Dec 10, 2024
Merged

add new torchdata.nodes doc file#1390
divyanshk merged 4 commits intomainfrom
divyanshk/add-nodes-doc

Conversation

@divyanshk
Copy link
Copy Markdown
Contributor

@divyanshk divyanshk commented Dec 9, 2024

Clone the repo on local, created the environment, updated the /docs folder, thenmake html and sphinx-serve -b build.

Screenshot 2024-12-09 at 3 46 59 PM Screenshot 2024-12-09 at 3 47 24 PM

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Dec 9, 2024
Comment thread 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>`_.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we flip it and have README point here, and copy/paste most of the README here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented Dec 9, 2024

🔗 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 SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

✅ No Failures

As of commit 32ee5f7 with merge base aaeb157 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

Copy link
Copy Markdown
Contributor

@andrewkho andrewkho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks amazing!

@andrewkho
Copy link
Copy Markdown
Contributor

Maybe for Tutorials/Examples we can have "Coming soon" or something for torchdata.nodes

@divyanshk
Copy link
Copy Markdown
Contributor Author

@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.

@divyanshk divyanshk merged commit e316c5c into main Dec 10, 2024
@divyanshk divyanshk deleted the divyanshk/add-nodes-doc branch December 10, 2024 04:14
divyanshk added a commit that referenced this pull request Dec 10, 2024
* add new torchdata.nodes doc file

* update main readme.md, move content of nodes readme.md to torchdata.nodes.rst

* main readme

* udpate readme
divyanshk added a commit that referenced this pull request Dec 10, 2024
* add new torchdata.nodes doc file

* update main readme.md, move content of nodes readme.md to torchdata.nodes.rst

* main readme

* udpate readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants