ray icon indicating copy to clipboard operation
ray copied to clipboard

[Doc] Clarify that session can also mean a ray cluster

Open jjyao opened this issue 2 years ago • 1 comments

Why are these changes needed?

Clarify in the glossary that session can also mean a ray cluster

Related issue number

Closes #35093

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 :(

jjyao avatar Jun 14 '23 18:06 jjyao

Can we use bullets points to clearly list the different meanings? Something like:

  • A Ray Train/Tune session, ....
  • A Ray Cluster instance,...

It's a bit hard for me to digest it when there are several paragraphs.

scottsun94 avatar Jun 15 '23 16:06 scottsun94