From e0b7a29a858f8cd95a106c1c5cdef05a14eab0c6 Mon Sep 17 00:00:00 2001 From: Mateusz Srebrny Date: Thu, 9 Nov 2023 14:26:27 +0100 Subject: [PATCH] ray 2.7.1 in readme (plus syncing quickstart with docs) --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index febece77..6212b635 100644 --- a/README.md +++ b/README.md @@ -33,45 +33,42 @@ If you have any questions, comments, insights, praises, or doubts about these do - [Limitations](#limitations) Describes the current limitations of Ray on Golem - [Quickstart](#quickstart) Drives you through copy and paste installation and execution of the example Ray app on example Ray on Golem cluster -- [Contributing](#contributing) Offers advice on building Golem images for Ray on Golem development purposes - # Limitations -Current version is `pre-alpha` which means the happy path is working on Ubuntu on the Golem test network. +Current version is `pre-alpha` which means the happy path is working on **Ubuntu** on the Golem test network. We have tested Ray on Golem on Ubuntu and on WSL, but it should work on other Linux distributions. At the moment, we don't support MacOS or bare Windows. We use this version to show the direction and get feedback. -There is one Ray on Golem image. It contains `ray 2.3` and `python 3.10`. +There is one Ray on Golem image. It contains `ray 2.7.1` and `python 3.10.13`. It should work with any combination of local ray & python versions. Please let us know if you have any troubles because of that (on [`#Ray on Golem` discord channel](https://chat.golem.network/)) The images include only basic libraries, if you need any dependencies, you can use `pip` via [cluster yaml `initialization_commands`](https://golem-docs-git-mateusz-ray-on-golem-pre-alpha-golem.vercel.app/docs/creators/ray/cluster-yaml-reference#initializationcommands) -We have tested Ray on Golem on Ubuntu and on WSL. It should work on MacOS and shouldn't on bare Windows. - -# QuickStart +# Quickstart This [quickstart](https://docs.golem.network/docs/creators/ray/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](https://docs.golem.network/docs/creators/ray/setup-tutorial) -We recommend creating a new directory and a clean Python virtual environment before you proceed. This avoids cluttering your system installation with unnecessary packages. ## Install software +**Note:** We recommend creating a new directory and a clean Python virtual environment before you proceed. This avoids cluttering your system installation with unnecessary packages. + The first step is installing Ray on Golem. It will install Ray as a dependency. ```bash -# install ray-on-golem and ray (recommended within a clean venv) +# install ray-on-golem & ray (recommended within a clean virtual environment) pip3 install -U ray-on-golem ``` -As a prerequisite, it also installs yagna - Golem daemon used to schedule work on the Golem Network. +**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. ## Set the cluster up -With the packages in place, you can download our sample golem cluster configuration yaml, and feed it to `ray up` to start up the cluster. +With the packages in place, you can download our sample golem cluster configuration yaml, and use it with `ray up` to start up the cluster. It will give you a cluster of one node (which will expand when you feed it with work) on the Golem test network (free, but not very powerful) ```bash @@ -86,6 +83,8 @@ ray up golem-cluster.yaml --yes ``` +Consult the [troubleshooting](/docs/creators/ray/troubleshooting) guide if anything goes wrong. + ## Execute a Ray application Download our example Ray app and execute it locally (a Ray instance will be created on your machine) @@ -101,7 +100,7 @@ python3 simple-task.py This particular script shows information about the cluster it is being run on and also visualizes the number of tasks run on different nodes (by default it executes 100 tasks). -Once you ensure the app works, you can feed it to your Ray on Golem cluster +Once you ensure the app works, you can feed it to your Ray on Golem cluster: ```bash # Submit the app to be executed on your cluster @@ -134,6 +133,7 @@ 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