-
Notifications
You must be signed in to change notification settings - Fork 6k
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.
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
[Datasets] Add glossary #32400
[Datasets] Add glossary #32400
Conversation
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
@bveeramani didn't we want a "global" glossary for all terms in Ray? This is great, just trying to understand the direction |
I think a global glossary makes sense. Should we add this Datasets glossary for now, and later consolidate the terms in a global glossary? Not sure when we'll add terms for the other libraries. |
I thought we want to add glossary section under each library? cc @richardliaw to confirm, thanks. |
>>> dataset = ray.data.range_table(10) | ||
>>> next(iter(dataset.iter_batches(batch_format="numpy", batch_size=5))) | ||
{'value': array([0, 1, 2, 3, 4])} | ||
>>> next(iter(dataset.iter_batches(batch_format="pandas", batch_size=5))) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shall we also add an example for map_batches(batch_format=...)
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we should. Meaningful map_batches
examples are relatively complicated, and I don't think we should include long examples in the glossary. Also, since we link to UDF Input Batch Formats
, I think we should be okay.
Let's start here and then we can adjust it as more libraries start adding. @c21 @bveeramani |
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Failing tests are unrelated: book-linkcheck
book-documentation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM overall, mostly formatting nits!
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, this is an awesome addition, and has been sorely missed for a long time! 👏
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great to see this glossary!
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Closes ray-project#30408 Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Closes ray-project#30408 Signed-off-by: elliottower <elliot@elliottower.com>
Signed-off-by: Balaji Veeramani balaji@anyscale.com
Why are these changes needed?
Related issue number
Closes #30408
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.