Skip to content

Update data loading docs - #361

Open
jzheng106 wants to merge 18 commits into
mainfrom
update-dataloading-docs
Open

jzheng106 wants to merge 18 commits into
mainfrom
update-dataloading-docs

Conversation

@jzheng106

Copy link
Copy Markdown
Contributor

Improvements to data loading documentation, as part of Jason's internship project. Reorganized the "Data Loading" tab of the public-facing documentation, and added new section regarding 2-phase shuffled read. Slack me with questions

@westonpace westonpace left a comment

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.

Various suggestions but overall this looks like a great improvement. I think many of these suggestions were issues present in the previous iteration as well.

Comment thread docs/training/data-loading.mdx Outdated
Comment thread docs/training/data-loading.mdx Outdated
Comment thread docs/training/data-loading.mdx Outdated
Comment thread docs/training/data-loading.mdx Outdated
Comment thread docs/training/data-loading.mdx
Comment thread docs/training/data-loading.mdx Outdated
Comment thread docs/training/data-loading.mdx Outdated
Comment thread docs/training/data-loading.mdx Outdated
Comment thread docs/training/data-loading.mdx Outdated
##### Checkpointing with Multiple DataLoader Workers

Use `StreamingDataLoader` when you want multi-worker prefetch and exact resumability. It carries a state snapshot
Python's built-in `torch.utils.data.DataLoader` produces a safe checkpoint when `num_workers = 0`. With `num_workers > 0`, calling `state_dict()` on the often raises `RuntimeError`. In this case, use `StreamingDataLoader` for multi-worker prefetch and exact resumability. It carries a state snapshot

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.

"calling state_dict() on the often <-- grammar

Also though, does DataLoader have a state_dict function? What is this talking about?

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.

I don't know. Inherited from the previous version

jzheng106 and others added 3 commits September 18, 2026 12:36
Co-authored-by: Weston Pace <weston.pace@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants