Package: ray-on-golem
Ray on GolemWhat is Golem, Ray and Ray on GolemGolemis a decentralized marketplace for computing power, where providers let requestors use their machines for a small fee.Ray on Golem makes it super easy to set up and use Golem Network to run your Ray applications.Rayon the other hand is an open-source framework dedicated to scaling Python workloads.
It specializes in tooling for AI/ML applications, but at the same time, it is based on Ray Core which understands every piece of generic Python code.Ray uses concepts of tasks, actors, and objects to enable building and scaling distributed software.
It can be used to parallelize your Python code to use all cores on your own computer, but more importantly, it also offers a cluster interface to run your payload on several, remote machines.You can learn about Ray Core mechanisms onRay docs websiteor check outRay on Golem docsto dive right into development.QuickstartThisquickstartshows 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 tosetup tutorialInstall softwareNote: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.# install ray-on-golem and ray (recommended within a clean virtual environment)pip3install-Uray-on-golemNote:As an added convenience, the installation ofray-on-golemensures that bothrayandyagnaare 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 upWith the packages in place, you can download our sample golem cluster configuration yaml, and use it withray upto 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)# Download the golem-cluster.yamlwgethttps://github.com/golemfactory/ray-on-golem/raw/main/golem-cluster.yaml# In this command:# * yagna starts in the background (if not running)# * ray-on-golem cluster manager starts in the background# * ray head node is started on a golem providerrayupgolem-cluster.yaml--yesConsult thetroubleshootingguide if anything goes wrong.Execute a Ray applicationDownload our example Ray app and execute it locally (a Ray instance will be created on your machine)# Download the example Ray appwgethttps://github.com/golemfactory/ray-on-golem/raw/main/examples/simple-task.py# Execute the app locally by starting a local ray instance on your computerpython3simple-task.pyThis 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:# Submit the app to be executed on your clusterraysubmitgolem-cluster.yamlsimple-task.pyYou can see the information about the cluster both before and after running the computations.Submit the code again, requesting more tasks to see how the autoscaler expands the cluster, as the work progresses (give it up to 5 mins).# Submit the app with 400 tasksraysubmitgolem-cluster.yamlsimple-task.py----count400The above shows the usual workflow with Ray apps.You develop them, while at the same time testing them, on your local machine.When you are ready to get more power - you send them to a Ray clusterwithout changing a single lineof your application's code.Stop the clusterFinally, stop your cluster to free the Golem network providers and to avoid spending more than needed (the testnet is free, but good practice is a good practice).# Tear down the cluster.raydowngolem-cluster.yaml--yesSummaryBy completing the above quickstart you have successfully:Installed ray and ray-on-golem packagesDownloaded the example golem cluster yaml and the example ray applicationStarted up the Ray on Golem clusterRun the app on your local computer and then on the clusterStopped the clusterCongratulations!LimitationsCurrent version isalphawhich means the happy path is working onUbuntuon the Golem test and main networks.
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 containsray 2.7.1andpython 3.10.13.
It should work with any combination of local ray and python versions. Please let us know if you have any troubles because of that (on#Ray on Golemdiscord channel)The images include only basic libraries, if you need any dependencies,
you can usepipviacluster yamlinitialization_commandsNext stepsExploreRay on Golem docsto learn more about various aspects and usages of our platform.If you have any questions, comments, insights, praises, or doubts about these docs and Ray on Golem in general please don't hesitate to reach out to us either on#Ray on Golemdiscord channelRay on Golem general feedback form