Skip to content

Commit

Permalink
[doc] Add Anyscale as an option to get started with Ray (ray-project#…
Browse files Browse the repository at this point in the history
…50772)

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

<!-- Please give a short summary of the change and the problem this
solves. -->
Adding Anyscale as an option to get started with Ray. This is the first
round of changes to add the option to 3 pages.

## Related issue number

<!-- For example: "Closes ray-project#1234" -->

## 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.
- [ ] 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: Sijie Wang <3463757+sijieamoy@users.noreply.github.com>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
  • Loading branch information
2 people authored and xsuler committed Mar 4, 2025
1 parent 7244563 commit 92f8aec
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/source/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -401,3 +401,8 @@ table.autosummary tr > td:first-child > p > a > code > span {
readthedocs-flyout {
display: none !important;
}

/* Styling the experimental Anyscale upsell CTA */
.anyscale-cta {
margin-bottom: 16px;
}
20 changes: 20 additions & 0 deletions doc/source/_static/img/try-ray-on-anyscale.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/source/cluster/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Ray provides native cluster deployment support on the following technology stack

* On :ref:`AWS and GCP <cloud-vm-index>`. Community-supported Azure, Aliyun and vSphere integrations also exist.
* On :ref:`Kubernetes <kuberay-index>`, via the officially supported KubeRay project.
* On `Anyscale <https://www.anyscale.com/ray-on-anyscale?utm_source=ray_docs&utm_medium=docs&utm_campaign=ray-doc-upsell&utm_content=ray-cluster-deployment>`_, a fully managed Ray platform by the creators of Ray. You can either bring an existing AWS, GCP, Azure and Kubernetes clusters, or use the Anyscale hosted compute layer.

Advanced users may want to :ref:`deploy Ray manually <on-prem>`
or onto :ref:`platforms not listed here <ref-cluster-setup>`.
Expand Down
2 changes: 2 additions & 0 deletions doc/source/cluster/kubernetes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ See [Getting Started](kuberay-quickstart) to learn the basics of KubeRay and fol
* [RayJob Quick Start](kuberay-rayjob-quickstart)
* [RayService Quick Start](kuberay-rayservice-quickstart)

Additionally, [Anyscale](https://www.anyscale.com/ray-on-anyscale?utm_source=ray_docs&utm_medium=docs&utm_campaign=ray-doc-upsell&utm_content=deploy-ray-on-k8s) is the managed Ray platform developed by the creators of Ray. It offers an easy path to deploy Ray clusters on your existing Kubernetes infrastructure, including EKS, GEK, AKS, or self-hosted Kubernetes.

## Learn More

The Ray docs present all the information you need to start running Ray workloads on Kubernetes.
Expand Down
33 changes: 33 additions & 0 deletions doc/source/ray-overview/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,18 @@ with 4 workers, and use it to run the new training function.
:end-before: __torch_trainer_end__
:dedent: 4
```
To accelerate the training job using GPU, make sure you have GPU configured, then set `use_gpu` to `True`. If you don't have a GPU environment, Anyscale provides a development workspace integrated with an autoscaling GPU cluster for this purpose.
<div class="anyscale-cta">
<a href="https://www.anyscale.com/ray-on-anyscale?utm_source=ray_docs&utm_medium=docs&utm_campaign=ray-doc-upsell&utm_content=get-started-train-torch">
<img src="../_static/img/try-ray-on-anyscale.svg" alt="Try Ray on Anyscale">
</a>
</div>
````
````{tab-item} TensorFlow
This example shows how you can use Ray Train to set up [Multi-worker training
Expand Down Expand Up @@ -198,6 +208,14 @@ with 4 workers, and use it to run the new training function.
:dedent: 0
```
To accelerate the training job using GPU, make sure you have GPU configured, then set `use_gpu` to `True`. If you don't have a GPU environment, Anyscale provides a development workspace integrated with an autoscaling GPU cluster for this purpose.
<div class="anyscale-cta">
<a href="https://www.anyscale.com/ray-on-anyscale?utm_source=ray_docs&utm_medium=docs&utm_campaign=ray-doc-upsell&utm_content=get-started-train-tf">
<img src="../_static/img/try-ray-on-anyscale.svg" alt="Try Ray on Anyscale">
</a>
</div>
```{button-ref} ../train/train
:color: primary
:outline:
Expand Down Expand Up @@ -604,6 +622,21 @@ Learn more about launching Ray Clusters on Kubernetes
`````

`````{dropdown} <img src="images/ray_svg_logo.svg" alt="ray" width="50px"> Clusters: Launching a Ray Cluster on Anyscale
:animate: fade-in-slide-down
Anyscale is the company behind Ray. The Anyscale platform provides an enterprise-grade Ray deployment on top of your AWS, GCP, Azure, or on-prem Kubernetes clusters.
```{button-link} https://www.anyscale.com/ray-on-anyscale?utm_source=ray_docs&utm_medium=docs&utm_campaign=ray-doc-upsell&utm_content=get-started-launch-ray-cluster
:color: primary
:outline:
:expand:
Try Ray on Anyscale
```
`````

## Debugging and Monitoring Quickstart

Use built-in observability tools to monitor and debug Ray applications and clusters.
Expand Down

0 comments on commit 92f8aec

Please sign in to comment.