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

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

Merged
merged 11 commits into from
Mar 14, 2024

Conversation

MysteryManav
Copy link
Contributor

@MysteryManav MysteryManav commented Mar 3, 2024

Docs: Added warning in documentation against installing Ray in base environment #3082

Tested (run the relevant ones):

  • Code formatting: bash format.sh
  • Any manual or new tests for this PR (please specify below)
  • All smoke tests: pytest tests/test_smoke.py
  • Relevant individual smoke tests: pytest tests/test_smoke.py::test_fill_in_the_name
  • Backward compatibility tests: bash tests/backward_comaptibility_tests.sh

@MysteryManav
Copy link
Contributor Author

@Michaelvll if you would, please take a look at it and notify for any additional changes

@@ -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 : )

@MysteryManav
Copy link
Contributor Author

any more suggestions ?

Copy link
Collaborator

@Michaelvll Michaelvll left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this @MysteryManav! Just left several comments.

docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
@MysteryManav
Copy link
Contributor Author

thankful for the opportunity and the guidance @Michaelvll

Copy link
Collaborator

@Michaelvll Michaelvll left a comment

Choose a reason for hiding this comment

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

Thanks for updating the doc @MysteryManav! This seems good to me as a basic version. We should probably have a more detailed explanation for those concept, e.g. the relationship with ray, etc.
cc'ing @concretevitamin for another look.

docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
Copy link
Member

@concretevitamin concretevitamin left a comment

Choose a reason for hiding this comment

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

Awesome, LGTM too @MysteryManav!

@MysteryManav
Copy link
Contributor Author

MysteryManav commented Mar 14, 2024

@concretevitamin @Michaelvll commited a last suggestion just now

Thanks

@Michaelvll Michaelvll merged commit f72d538 into skypilot-org:master Mar 14, 2024
19 checks passed
@MysteryManav MysteryManav deleted the docs/multiple-ray-warning branch March 14, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants