Skip to content

[Data][Doc] Add tip about how to understand map_batches format#47394

Merged
pcmoritz merged 4 commits intoray-project:masterfrom
pcmoritz:update-map-batches-docs
Oct 4, 2024
Merged

[Data][Doc] Add tip about how to understand map_batches format#47394
pcmoritz merged 4 commits intoray-project:masterfrom
pcmoritz:update-map-batches-docs

Conversation

@pcmoritz
Copy link
Contributor

@pcmoritz pcmoritz commented Aug 29, 2024

Why are these changes needed?

Add a note to help users understand the format inside map_batches.

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

@pcmoritz
Copy link
Contributor Author

@SolitaryThinker let me know if you have any feedback / some other phrasing would be more effective :)

@anyscalesam anyscalesam added triage Needs triage (eg: priority, bug/not-bug, and owning component) docs An issue or change related to documentation data Ray Data-related issues labels Sep 6, 2024
Copy link
Member

@bveeramani bveeramani left a comment

Choose a reason for hiding this comment

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

Nice. ty

pcmoritz and others added 2 commits October 3, 2024 11:35
Co-authored-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>
@pcmoritz pcmoritz enabled auto-merge (squash) October 3, 2024 20:59
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Oct 3, 2024
@pcmoritz pcmoritz disabled auto-merge October 4, 2024 01:05
@pcmoritz pcmoritz merged commit 48a0444 into ray-project:master Oct 4, 2024
@pcmoritz pcmoritz deleted the update-map-batches-docs branch October 4, 2024 01:05
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
…roject#47394)

<!-- 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?

Add a note to help users understand the format inside map_batches.

<!-- Please give a short summary of the change and the problem this
solves. -->

## Related issue number

<!-- For example: "Closes ray-project#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: Philipp Moritz <pcmoritz@gmail.com>
Co-authored-by: Balaji Veeramani <bveeramani@berkeley.edu>
Signed-off-by: ujjawal-khare <ujjawal.khare@dream11.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

data Ray Data-related issues docs An issue or change related to documentation go add ONLY when ready to merge, run all tests triage Needs triage (eg: priority, bug/not-bug, and owning component)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants