Skip to content
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

[Data] [Docs] Improve docs around Parquet filter predicate / column selection pushdown #48095

Merged
merged 2 commits into from
Oct 21, 2024
Merged

[Data] [Docs] Improve docs around Parquet filter predicate / column selection pushdown #48095

merged 2 commits into from
Oct 21, 2024

Conversation

scottjlee
Copy link
Contributor

@scottjlee scottjlee commented Oct 17, 2024 •
edited
Loading

Why are these changes needed?

Improve docs around Parquet filter predicate / column selection pushdown, so that they are easier to access from multiple parts of the Ray Data docs, and improve the clarity of examples.

Modified pages:

reading_files performance_tips select_columns filter

Related issue number

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 :(

@scottjlee
update docs
30e2271 
Signed-off-by: Scott Lee <sjl@anyscale.com>
@scottjlee
vale lint
73a80a9 
Signed-off-by: Scott Lee <sjl@anyscale.com>
@scottjlee scottjlee marked this pull request as ready for review October 18, 2024 00:34
@scottjlee scottjlee enabled auto-merge (squash) October 21, 2024 20:16
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Oct 21, 2024
bveeramani
bveeramani approved these changes Oct 21, 2024
View reviewed changes
doc/source/data/performance-tips.rst
Comment on lines 200 to 201
If you only need a subset of the columns, make sure to specify the list of columns
explicitly when calling :func:`ray.data.read_parquet` to
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If you only need a subset of the columns, make sure to specify the list of columns
explicitly when calling :func:`ray.data.read_parquet` to
If you only need a subset of the columns, specify the list of columns
explicitly when calling :func:`ray.data.read_parquet` to

@scottjlee scottjlee merged commit 503e07b into ray-project:master Oct 21, 2024
7 checks passed
Jay-ju pushed a commit to Jay-ju/ray that referenced this pull request Nov 5, 2024
@scottjlee @Jay-ju
[Data] [Docs] Improve docs around Parquet filter predicate / column s…
9360a56 
…election pushdown (ray-project#48095)

## Why are these changes needed?

Improve docs around Parquet filter predicate / column selection
pushdown, so that they are easier to access from multiple parts of the
Ray Data docs, and improve the clarity of examples.

Modified pages:
- [Loading
Data](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/loading-data.html)
<img width="1298" alt="reading_files"
src="https://github.com/user-attachments/assets/c760ecd4-4cfe-4547-8b88-3026fa12a13a">

- [Performance
tips](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/performance-tips.html#parquet-column-pruning-projection-pushdown)
<img width="1311" alt="performance_tips"
src="https://github.com/user-attachments/assets/1fc894ae-dabf-4c33-bc27-ba0dcc9fddff">

-
[`Dataset.select_columns`](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/api/doc/ray.data.Dataset.select_columns.html#ray.data.Dataset.select_columns)
<img width="1338" alt="select_columns"
src="https://github.com/user-attachments/assets/483a4bf2-acc7-4ca3-90e1-3f66563b3365">

-
[`Dataset.filter`](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/api/doc/ray.data.Dataset.filter.html#ray.data.Dataset.filter)
<img width="1319" alt="filter"
src="https://github.com/user-attachments/assets/a9b1beb6-5b7c-415f-97b9-c2119513adde">

## Related issue number

## Checks

- [x] I've signed off every commit(by using the -s flag, i.e., `git
commit -s`) in this PR.
- [x] I've run `scripts/format.sh` to lint the changes in this PR.
- [x] 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.
- [x] 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: Scott Lee <sjl@anyscale.com>
JP-sDEV pushed a commit to JP-sDEV/ray that referenced this pull request Nov 14, 2024
@scottjlee @JP-sDEV
[Data] [Docs] Improve docs around Parquet filter predicate / column s…
3c93a9d 
…election pushdown (ray-project#48095)

## Why are these changes needed?

Improve docs around Parquet filter predicate / column selection
pushdown, so that they are easier to access from multiple parts of the
Ray Data docs, and improve the clarity of examples.

Modified pages:
- [Loading
Data](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/loading-data.html)
<img width="1298" alt="reading_files"
src="https://github.com/user-attachments/assets/c760ecd4-4cfe-4547-8b88-3026fa12a13a">

- [Performance
tips](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/performance-tips.html#parquet-column-pruning-projection-pushdown)
<img width="1311" alt="performance_tips"
src="https://github.com/user-attachments/assets/1fc894ae-dabf-4c33-bc27-ba0dcc9fddff">

-
[`Dataset.select_columns`](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/api/doc/ray.data.Dataset.select_columns.html#ray.data.Dataset.select_columns)
<img width="1338" alt="select_columns"
src="https://github.com/user-attachments/assets/483a4bf2-acc7-4ca3-90e1-3f66563b3365">

-
[`Dataset.filter`](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/api/doc/ray.data.Dataset.filter.html#ray.data.Dataset.filter)
<img width="1319" alt="filter"
src="https://github.com/user-attachments/assets/a9b1beb6-5b7c-415f-97b9-c2119513adde">

## Related issue number

## Checks

- [x] I've signed off every commit(by using the -s flag, i.e., `git
commit -s`) in this PR.
- [x] I've run `scripts/format.sh` to lint the changes in this PR.
- [x] 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.
- [x] 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: Scott Lee <sjl@anyscale.com>
mohitjain2504 pushed a commit to mohitjain2504/ray that referenced this pull request Nov 15, 2024
@scottjlee @mohitjain2504
[Data] [Docs] Improve docs around Parquet filter predicate / column s…
42f4cbe 
…election pushdown (ray-project#48095)

## Why are these changes needed?

Improve docs around Parquet filter predicate / column selection
pushdown, so that they are easier to access from multiple parts of the
Ray Data docs, and improve the clarity of examples.

Modified pages:
- [Loading
Data](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/loading-data.html)
<img width="1298" alt="reading_files"
src="https://github.com/user-attachments/assets/c760ecd4-4cfe-4547-8b88-3026fa12a13a">

- [Performance
tips](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/performance-tips.html#parquet-column-pruning-projection-pushdown)
<img width="1311" alt="performance_tips"
src="https://github.com/user-attachments/assets/1fc894ae-dabf-4c33-bc27-ba0dcc9fddff">

-
[`Dataset.select_columns`](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/api/doc/ray.data.Dataset.select_columns.html#ray.data.Dataset.select_columns)
<img width="1338" alt="select_columns"
src="https://github.com/user-attachments/assets/483a4bf2-acc7-4ca3-90e1-3f66563b3365">

-
[`Dataset.filter`](https://anyscale-ray--48095.com.readthedocs.build/en/48095/data/api/doc/ray.data.Dataset.filter.html#ray.data.Dataset.filter)
<img width="1319" alt="filter"
src="https://github.com/user-attachments/assets/a9b1beb6-5b7c-415f-97b9-c2119513adde">

## Related issue number

## Checks

- [x] I've signed off every commit(by using the -s flag, i.e., `git
commit -s`) in this PR.
- [x] I've run `scripts/format.sh` to lint the changes in this PR.
- [x] 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.
- [x] 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: Scott Lee <sjl@anyscale.com>
Signed-off-by: mohitjain2504 <mohit.jain@dream11.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@srinathk10 srinathk10 srinathk10 approved these changes

@bveeramani bveeramani bveeramani approved these changes

@raulchen raulchen Awaiting requested review from raulchen raulchen is a code owner

@stephanie-wang stephanie-wang Awaiting requested review from stephanie-wang stephanie-wang is a code owner

@omatthew98 omatthew98 Awaiting requested review from omatthew98 omatthew98 is a code owner

Assignees

@bveeramani bveeramani

@srinathk10 srinathk10

Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@scottjlee @bveeramani @srinathk10