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.

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

[Data] Soft deprecate prefetch_blocks parameter of iter_rows #43349

Merged

Conversation

bveeramani
Copy link
Member

Why are these changes needed?

This PR deprecates the prefetch_blocks in favor of a new prefetch_batches parameter for consistency with other iteration APIs, which have used prefetch_batches since Ray 2.4 (see #43347)

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

Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
python/ray/data/dataset.py Outdated Show resolved Hide resolved
python/ray/data/iterator.py Outdated Show resolved Hide resolved
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
@bveeramani bveeramani merged commit a8cb077 into ray-project:master Feb 22, 2024
9 checks passed
@bveeramani bveeramani deleted the deprecate-iter-rows-prefetch-blocks branch February 22, 2024 22:35
bveeramani added a commit that referenced this pull request Apr 26, 2024
…ault value (#44982)

This PR deprecates the `prefetch_batches` parameter of
`Dataset.iter_rows` because it leaks an implementation detail (namely,
that we use `Dataset.iter_batches` under-the-hood). This PR also
increases the default value for 1) consistency with `iter_batches` and
2) to improve performance.

For historical context, #43349
erroneously introduced the `prefetch_batches` parameter.


Signed-off-by: Balaji Veeramani <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants