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

Proposed Ray PR changes #142

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/markdoc/partials/ray/installation-alert.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% alert level="info" %}
**Note:** As an added convenience, the installation of `ray-on-golem` ensures that both `ray` and `yagna` are set up for you. With these components in place, you're well-prepared to harness the full potential of Ray on the Golem Network.
{% /alert %}
7 changes: 3 additions & 4 deletions src/markdoc/partials/ray/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@

# QuickStart

This quickstart shows you how to set Ray and Ray on Golem up, start your cluster, test it, and then stop it.
It limits the explanation to the bare minimum - if you are looking for more details jump to [setup tutorial](/docs/creators/ray/setup-tutorial)


## Install software

{% partial file="ray/recommend-venv.md" /%}
Expand All @@ -15,7 +13,8 @@ The first step is installing Ray on Golem. It will install Ray as a dependency.
# install ray-on-golem & ray (recommended within a clean virtual environment)
pip3 install -U ray-on-golem
```
As a prerequisite, it also installs yagna - the Golem node software which is essential for connecting to the Golem network.

{% partial file="ray/installation-alert.md" /%}

## Set the cluster up

Expand Down Expand Up @@ -50,11 +49,11 @@ ray down golem-cluster.yaml --yes
## Summary

By completing the above quickstart you have successfully:

- Installed ray and ray-on-golem packages
- Downloaded the example golem cluster yaml and the example ray application
- Started up the Ray on Golem cluster
- Run the app on your local computer and then on the cluster
- Stopped the cluster

Congratulations!

Loading
Loading