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

Jump to bottom

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

Merged
merged 3 commits into from
Jun 15, 2023
Merged

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

merged 3 commits into from
Jun 15, 2023

Conversation

jjyao
Copy link
Collaborator

@jjyao jjyao commented Jun 14, 2023

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
Clarify that session can also mean a ray cluster
b6aa3b6 
Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@jjyao jjyao requested a review from a team as a code owner June 14, 2023 18:23
@scottsun94
Copy link
Contributor

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.

@jjyao
up
63c1dea 
Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
scottsun94
scottsun94 approved these changes Jun 15, 2023
View reviewed changes
Copy link
Contributor

@scottsun94 scottsun94 left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

angelinalg
angelinalg approved these changes Jun 15, 2023
View reviewed changes
doc/source/ray-references/glossary.rst Outdated Show resolved Hide resolved
doc/source/ray-references/glossary.rst Outdated Show resolved Hide resolved
doc/source/ray-references/glossary.rst Outdated Show resolved Hide resolved
@jjyao @angelinalg
Apply suggestions from code review
dc88dfb 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@jjyao jjyao merged commit ba7d490 into ray-project:master Jun 15, 2023
@jjyao jjyao deleted the jjyao/session branch June 15, 2023 22:07
@akshay-anyscale akshay-anyscale mentioned this pull request Jul 21, 2023
Closed
8 tasks
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
@jjyao @arvind-chandra
[Doc] Clarify that session can also mean a ray cluster (ray-project#3…
b3200e2 
…6422)

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angelinalg angelinalg angelinalg approved these changes

@scottsun94 scottsun94 scottsun94 approved these changes

Assignees

@scottsun94 scottsun94

@angelinalg angelinalg

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Glossary] The definition of "session" is not complete
3 participants
@jjyao @scottsun94 @angelinalg