[Data] Add read_json docs example for setting PyArrow block size when reading large files
#40533
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: Scott Lee <sjl@anyscale.com>
scottjlee
requested review from
ericl,
scv119,
c21,
amogkam,
bveeramani,
raulchen,
stephanie-wang and
Zandew
as code owners
c21
approved these changes
Oct 20, 2023
bveeramani
reviewed
Oct 20, 2023
python/ray/data/read_api.py
Outdated
| When reading large files, the default block size configured in PyArrow can be too small, | ||
| resulting in the following error: | ||
| ``pyarrow.lib.ArrowInvalid: straddling object straddles two block boundaries | ||
| (try to increase block size?)`` |
There was a problem hiding this comment.
Suggested change
| (try to increase block size?)`` | |
| (try to increase block size?)``. |
python/ray/data/read_api.py
Outdated
Comment on lines
1048
to
1049
| >>> ray.data.read_json(..., | ||
| ... read_options=pajson.ReadOptions(block_size=block_size)) |
There was a problem hiding this comment.
Suggested change
| >>> ray.data.read_json(..., | |
| ... read_options=pajson.ReadOptions(block_size=block_size)) | |
| >>> ray.data.read_json( | |
| ... s3://anonymous@ray-example-data/log.json, | |
| ... read_options=pajson.ReadOptions(block_size=block_size) | |
| ... ) |
There was a problem hiding this comment.
If you wanted to, you could add a large-log.json to make this example more realistic, but I don't think that's necessary
c21
approved these changes
Oct 23, 2023
python/ray/data/read_api.py
Outdated
| >>> import pyarrow.json as pajson | ||
| >>> block_size = 10 << 20 # Set block size to 10MB | ||
| >>> ray.data.read_json( | ||
| ... s3://anonymous@ray-example-data/log.json, |
There was a problem hiding this comment.
missing the "" - "s3://anonymous@ray-example-data/log.json"
There was a problem hiding this comment.
thanks for the catch, just fixed
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
Signed-off-by: Scott Lee <sjl@anyscale.com>
…into 1020-json-blocksize
ujjawal-khare
pushed a commit
to ujjawal-khare-27/ray
that referenced
this pull request
Nov 29, 2023
…en reading large files (ray-project#40533) Adds an example for a workaround when reading large files with ray.data.read_json, which involves setting the block size used by PyArrow's JSON loader. Generated docs page --------- Signed-off-by: Scott Lee <sjl@anyscale.com>
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?
Adds an example for a workaround when reading large files with
ray.data.read_json, which involves setting the block size used by PyArrow's JSON loader. Generated docs pageRelated issue number
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.