8000 [Docs] Clarify Train-side docs on Ray Data by crypdick · Pull Request #53349 · ray-project/ray · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[Docs] Clarify Train-side docs on Ray Data #53349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[Docs] Clarify Train-side docs on Ray Data #53349

wants to merge 5 commits into from

Conversation

crypdick
Copy link
Contributor

Why are these changes needed?

Doing some work to clarify how to use Ray Data with Ray Train within the Train docs.

  1. makes api docs for prepare_data_loader abundantly clear that it is for Pytorch Dataloaders

image

  1. Clarify on the note recommending loading datasets inside train_func that the recommendation does not apply if using Ray Data

Related issue number

N/A

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

crypdick added 3 commits May 27, 2025 17:36
@crypdick
clarify that code is different for ray data
a8cda32 
Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
@crypdick
clarify that torch utils are for pytorch classes
9787823 
Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
@crypdick
typos
3cf50c9 
Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
@crypdick crypdick requested review from a team as code owners May 28, 2025 00:43
@crypdick
rm confusing 'directly'
5d7fc41 
Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
crypdick
crypdick commented May 29, 2025
View reviewed changes
python/ray/train/torch/train_loop_utils.py
@@ -197,7 +197,7 @@ def prepare_data_loader(
move_to_device: bool = True,
auto_transfer: bool = True,
) -> torch.utils.data.DataLoader:
"""Prepares :class:`~torch.utils.data.DataLoader` for distributed execution.
"""Prepares PyTorch :class:`~torch.utils.data.DataLoader` for distributed execution.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

API docs don't indicate that this is the pytorch class unless you click the URL
image

@crypdick crypdick added docs An issue or change related to documentation train Ray Train Related Issue go add ONLY when ready to merge, run all tests labels Jun 5, 2025
@github-actions GitHub Actions
Copy link

This pull request has been automatically marked as stale because it has not had
any activity for 14 days. It will be closed in another 14 days if no further activity occurs.
Thank you for your contributions.

You can always ask for help on our discussion forum or Ray's public slack channel.

If you'd like to keep this open, just leave any comment, and the stale label will be removed.

@github-actions github-actions bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Jun 20, 2025
@richardliaw richardliaw added the data Ray Data-related issues label Jun 28, 2025
@github-actions github-actions bot removed the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Jun 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
data Ray Data-related issues docs An issue or change related to documentation go add ONLY when ready to merge, run all tests train Ray Train Related Issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@crypdick @richardliaw
0