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

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

Merged
merged 3 commits into from
Jun 15, 2023
Merged
Changes from 2 commits
Commits
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
23 changes: 13 additions & 10 deletions doc/source/ray-references/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -533,16 +533,19 @@ documentation, sorted alphabetically.
used to combine multiple deployments into “deployment graphs.”

Session
The session concept exists on several levels: The experiment execution layer
(called Tune Session) and the Data Parallel training layer (called Train
Session) if running data-parallel distributed training with Ray Train.

The session allows access to metadata such as which trial is being run,
information about the total number of workers as well as the rank of the
current worker. The session is also the interface through which an individual
Trainable can interact with the Tune experiment as a whole. This includes uses
such as reporting an individual trial’s metrics, saving/loading checkpoints,
and retrieving the corresponding dataset shards for each Train worker.
- A Ray Train/Tune session: Tune session at the experiment execution layer
and Train session at the Data Parallel training layer
if running data-parallel distributed training with Ray Train.

The session allows access to metadata such as which trial is being run,
jjyao marked this conversation as resolved.
Show resolved Hide resolved
information about the total number of workers as well as the rank of the
jjyao marked this conversation as resolved.
Show resolved Hide resolved
current worker. The session is also the interface through which an individual
Trainable can interact with the Tune experiment as a whole. This includes uses
such as reporting an individual trial’s metrics, saving/loading checkpoints,
and retrieving the corresponding dataset shards for each Train worker.

- A Ray cluster: in some cases the session also means a :term:`Ray Cluster`.
For example logs of a Ray cluster are stored under ``session_xxx/logs/``.
jjyao marked this conversation as resolved.
Show resolved Hide resolved

Spillback
A task caller schedules a task by first sending a resource request to the
Expand Down