[Data][Doc] Add doc to summarize different shuffle options #42358
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Cheng Su <[email protected]>
c21
requested review from
ericl,
scv119,
amogkam,
scottjlee,
bveeramani,
raulchen,
stephanie-wang and
Zandew
as code owners
bveeramani
approved these changes
Jan 12, 2024
|
|
||
| .. tip:: | ||
|
|
||
| This is the fastest option for shuffle, and is purely metadata operation. This |
There was a problem hiding this comment.
I feel like a word is missing here?
Suggested change
| This is the fastest option for shuffle, and is purely metadata operation. This | |
| This is the fastest option for shuffle, and is a purely metadata operation. This |
| .. tip:: | ||
|
|
||
| This is the fastest option for shuffle, and is purely metadata operation. This | ||
| option does not shuffle the actual rows inside files, so the randomness would be |
There was a problem hiding this comment.
Suggested change
| option does not shuffle the actual rows inside files, so the randomness would be | |
| option doesn't shuffle the actual rows inside files, so the randomness might be |
| @@ -323,8 +375,8 @@ To randomly shuffle all rows, call :meth:`~ray.data.Dataset.random_shuffle`. | |||
|
|
|||
| .. tip:: | |||
|
|
|||
| :meth:`~ray.data.Dataset.random_shuffle` is slow. For better performance, try | |||
| :ref:`Iterating over batches with shuffling <iterating-over-batches-with-shuffling>`. | |||
| This is the slowest option for shuffle, and requires tranasferring data across | |||
There was a problem hiding this comment.
Suggested change
| This is the slowest option for shuffle, and requires tranasferring data across | |
| This is the slowest option for shuffle, and requires transferring data across |
Signed-off-by: Cheng Su <[email protected]>
vickytsang
pushed a commit
to ROCm/ray
that referenced
this pull request
Jan 12, 2024
…ct#42358) Improve the section in documentation to summarize different shuffle options, so users have a place to understand what shuffle options we have. Signed-off-by: Cheng Su <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
Improve the section in documentation to summarize different shuffle options, so users have a place to understand what shuffle options we have.
Related issue number
Closes #41970
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.