Skip to content

docs: warn about running multiple local Ray instances#45836

Merged
anyscalesam merged 2 commits intoray-project:masterfrom
davidxia:patch-8
Jul 9, 2024
Merged

docs: warn about running multiple local Ray instances#45836
anyscalesam merged 2 commits intoray-project:masterfrom
davidxia:patch-8

Conversation

@davidxia
Copy link
Contributor

@davidxia davidxia commented Jun 10, 2024

See https://discuss.ray.io/t/error-in-ray-job-submit-on-local-machine-if-multiple-clusters-are-running-at-the-same-time/14723/7?u=davidxia

Why are these changes needed?

Will prevent user confusion

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@davidxia
Copy link
Contributor Author

cc @anyscalesam

@kevin85421 kevin85421 self-assigned this Jul 3, 2024
@kevin85421 kevin85421 added the go add ONLY when ready to merge, run all tests label Jul 3, 2024
@davidxia
Copy link
Contributor Author

davidxia commented Jul 9, 2024

@kevin85421 @jjyao is this OK to merge?

@anyscalesam anyscalesam enabled auto-merge (squash) July 9, 2024 17:01
@anyscalesam anyscalesam merged commit 8f70e02 into ray-project:master Jul 9, 2024
@davidxia davidxia deleted the patch-8 branch July 9, 2024 18:43
Comment on lines +1309 to +1310
Running multiple local Ray instances is not supported and may have
undefined behavior.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is it not supposed? I think this is supported.

Copy link
Contributor Author

@davidxia davidxia Jul 10, 2024

Choose a reason for hiding this comment

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

Should this be "Running multiple local Ray instances is not recommended and may have undefined behavior." instead?

Even though it's possible to run multiple Ray instances on a single machine, is it not recommended? Both @anyscalesam here and @stephanie-wang in this other discussion thread have said it's not recommended. If it's not, I think it's helpful to state this?

Copy link
Contributor

Choose a reason for hiding this comment

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

You can do it as long as you provide unique ports for each Ray instance.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jjyao

  1. Do you have an example Python snippet showing how to do this with ray.init()?
  2. I understand it's possible, but I'm asking if it's not recommended?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jjyao just bumping again on the above questions

jjyao added a commit to jjyao/ray that referenced this pull request Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants