[Docs][Kuberay] Create an example doc for Modin #46345
Merged
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
MortalHappiness
requested review from
architkulkarni,
maxpumperla,
pcmoritz,
kevin85421 and
a team
as code owners
|
@kevin85421 Could you help me review this PR? Thanks. |
kevin85421
reviewed
Jul 2, 2024
|
|
||
| Create a file named `ray-job.modin.yaml` with the following content: | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
Add a YAML KubeRay repository.
| metadata: | ||
| name: ray-job-code-sample | ||
| data: | ||
| sample_code.py: | |
There was a problem hiding this comment.
Use a real-world example instead.
can-anyscale
requested changes
Jul 2, 2024
There was a problem hiding this comment.
- push back to your queue for @kevin85421's feedback
- do you mind add a screenshot or link to the generated page, thankks
4 tasks
MortalHappiness
force-pushed
the
docs/modin-example
branch
2 times, most recently
from
952abe6
to
ffb24d0
Compare
|
@can-anyscale PTAL. Thanks. |
kevin85421
reviewed
Jul 6, 2024
|
|
||
| Run the following command to check the output: | ||
|
|
||
| ```sh |
There was a problem hiding this comment.
Have you ever updated the logs after unwrapping the Modin example from a Ray task?
MortalHappiness
force-pushed
the
docs/modin-example
branch
from
ffb24d0
to
202e3c5
Compare
angelinalg
approved these changes
Jul 9, 2024
There was a problem hiding this comment.
Some suggestions for style consistency. Please consider installing Vale to check for these corrections. https://docs.ray.io/en/latest/ray-contribute/docs.html#how-to-use-vale
Please also verify the technical accuracy of my suggestion for an introductory sentence for Step 2, proposed line 13.
Thanks for making Ray docs better!!
|
|
||
| # Use Modin with Ray on Kubernetes | ||
|
|
||
| In this example, you will learn how to run a modified version of the [Using Modin with the NYC Taxi Dataset](https://github.com/modin-project/modin/blob/4e7afa7ea59c7a160ed504f39652ff23b4d49be3/examples/jupyter/Modin_Taxi.ipynb) example from the Modin official repository using RayJob on Kubernetes. |
There was a problem hiding this comment.
Suggested change
| In this example, you will learn how to run a modified version of the [Using Modin with the NYC Taxi Dataset](https://github.com/modin-project/modin/blob/4e7afa7ea59c7a160ed504f39652ff23b4d49be3/examples/jupyter/Modin_Taxi.ipynb) example from the Modin official repository using RayJob on Kubernetes. | |
| This example runs a modified version of the [Using Modin with the NYC Taxi Dataset](https://github.com/modin-project/modin/blob/4e7afa7ea59c7a160ed504f39652ff23b4d49be3/examples/jupyter/Modin_Taxi.ipynb) example from the Modin official repository using RayJob on Kubernetes. |
|
|
||
| In this example, you will learn how to run a modified version of the [Using Modin with the NYC Taxi Dataset](https://github.com/modin-project/modin/blob/4e7afa7ea59c7a160ed504f39652ff23b4d49be3/examples/jupyter/Modin_Taxi.ipynb) example from the Modin official repository using RayJob on Kubernetes. | ||
|
|
||
| ## Step 1: Install Kuberay operator |
There was a problem hiding this comment.
Suggested change
| ## Step 1: Install Kuberay operator | |
| ## Step 1: Install KubeRay operator |
|
|
||
| ## Step 1: Install Kuberay operator | ||
|
|
||
| Follow the steps 1 and 2 from the [RayCluster Quick Start](kuberay-raycluster-quickstart) guide to install Kuberay operator. |
There was a problem hiding this comment.
Suggested change
| Follow the steps 1 and 2 from the [RayCluster Quick Start](kuberay-raycluster-quickstart) guide to install Kuberay operator. | |
| Follow steps 1 and 2 from [RayCluster Quickstart](kuberay-raycluster-quickstart) to install KubeRay operator. |
| Follow the steps 1 and 2 from the [RayCluster Quick Start](kuberay-raycluster-quickstart) guide to install Kuberay operator. | ||
|
|
||
| ## Step 2: Run the Modin example with RayJob | ||
|
|
There was a problem hiding this comment.
Suggested change
| Create a RayJob that runs the Modin example using the following command: |
There was a problem hiding this comment.
@angelinalg Thank you! I've pushed updates according to your suggestions.
Resolves: ray-project/kuberay#2190 Signed-off-by: Chi-Sheng Liu <[email protected]>
MortalHappiness
force-pushed
the
docs/modin-example
branch
from
202e3c5
to
8910670
Compare
kevin85421
approved these changes
Jul 10, 2024
can-anyscale
approved these changes
Jul 12, 2024
Catch-Bull
pushed a commit
to Catch-Bull/ray
that referenced
this pull request
Jul 15, 2024
Signed-off-by: Chi-Sheng Liu <[email protected]> Signed-off-by: hejialing.hjl <[email protected]>
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?
See the description in the corresponding issue for details.
Related PR: ray-project/kuberay#2221
Related issue number
Resolves: ray-project/kuberay#2190
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.