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.

Sign up for GitHub

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

Docs: Add warning against installing Ray in base environment #3267

Merged
merged 11 commits into from
Mar 14, 2024
Merged

Docs: Add warning against installing Ray in base environment #3267

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c281c0d
Docs: Add warning against installing Ray in base environment
MysteryManav Mar 3, 2024
bf601db
Docs: Add warning against installing Ray in base environment
MysteryManav Mar 9, 2024
8f6f7ae
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
1f3b63f
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
a132beb
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
0b77d56
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
306c7f3
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
4cf16b0
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
86596e4
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
7d69735
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 10, 2024
683f103
Update docs/source/running-jobs/distributed-jobs.rst
MysteryManav Mar 14, 2024
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
11 changes: 11 additions & 0 deletions docs/source/running-jobs/distributed-jobs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,14 @@ This allows you directly to SSH into the worker nodes, if required.
# Worker nodes.
$ ssh mycluster-worker1
$ ssh mycluster-worker2


Executing a Distributed Ray Program
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For discussion: We may want to add a dedicated guide on how to use Ray as part of the user job. That page can use a tip like this. A full YAML example #3195 may help promote this recommendation more directly.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let’s add a yaml example of starting a distributed job with ray as mentioned above. We can try to move it to a separate page later after this pr is merged.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So for confirmation: I should add the command to run the example in distributed_ray_train, the one that uses FashionMNIST and add the command for tha yaml file and its output as example in the documentation ?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we can add the yaml file inline with the command to run that yaml : )

------------------------------------
.. warning::
**Avoid Installing Ray in Base Environment**

Before proceeding with the execution of a distributed Ray program, it is crucial to ensure that Ray is **not** installed in the base environment. Installing a different version of Ray in the base environment can lead to compatibility issues, conflicts, and unintended consequences.

To maintain a clean and stable environment for your distributed Ray program, it is highly recommended to **create a dedicated virtual environment** for Ray and its dependencies. This helps isolate the Ray installation and prevents interference with other packages in your base environment.
MysteryManav marked this conversation as resolved.
Show resolved Hide resolved

Loading