[Data] user column names read api doc changes #52587
Merged
Conversation
This file contains hidden or 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
iamjustinhsu
changed the title
iamjustinhsu
force-pushed
the
jhsu/read-api-column-names
branch
from
a2f70e3 to
8926984
Compare
iamjustinhsu
force-pushed
the
jhsu/read-api-column-names
branch
from
640e621 to
e2014b8
Compare
iamjustinhsu
changed the title
Signed-off-by: jhsu <jhsu@anyscale.com>
Signed-off-by: jhsu <jhsu@anyscale.com>
iamjustinhsu
force-pushed
the
jhsu/read-api-column-names
branch
from
32d92a3 to
235c2f7
Compare
…i-column-names Signed-off-by: jhsu <jhsu@anyscale.com>
iamjustinhsu
changed the title
bveeramani
approved these changes
May 1, 2025
python/ray/data/read_api.py
Outdated
Comment on lines
166
to
167
| Column name defaults to "item". | ||
Member
There was a problem hiding this comment.
Here and elsewhere -- this isn't describing the example(s), so IMO makes more sense to move it above to the main description.
For example:
"""Creates a :class:`~ray.data.Dataset` from image files.
Column name defaults to “image”.
...
python/ray/data/read_api.py
Outdated
| [0, 0]])}, {'data': array([[2, 2], | ||
| [2, 2]])}] | ||
| Colum name defaults to data. |
Member
There was a problem hiding this comment.
Suggested change
| Colum name defaults to data. | |
| Colum name defaults to "data". |
Signed-off-by: jhsu <jhsu@anyscale.com>
Signed-off-by: jhsu <jhsu@anyscale.com>
…i-column-names Signed-off-by: jhsu <jhsu@anyscale.com>
<!-- Thank you for your contribution! Please review https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before opening a pull request. --> <!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. --> ## Why are these changes needed? explicity document the default column names <!-- Please give a short summary of the change and the problem this solves. --> ## Related issue number <!-- For example: "Closes #1234" --> ## 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 :( --------- Signed-off-by: jhsu <jhsu@anyscale.com>
Signed-off-by: jhsu <jhsu@anyscale.com>
Signed-off-by: jhsu <jhsu@anyscale.com>
Signed-off-by: jhsu <jhsu@anyscale.com>
iamjustinhsu
requested review from
a team,
justinvyu,
kevin85421,
matthewdeng,
maxpumperla,
pcmoritz,
raulchen,
simonsays1980,
sven1977 and
woshiyyya
as code owners
…i-column-names Signed-off-by: jhsu <jhsu@anyscale.com>
iamjustinhsu
changed the title
…roject/ray into jhsu/read-api-column-names Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
20 participants
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?
Allows users to manipulate the column output names
Related issue number
Closes #52282
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.