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/train] Add Result guide #38359

Merged
merged 15 commits into from
Aug 17, 2023
Merged

Conversation

krfricke
Copy link
Contributor

Why are these changes needed?

This adds a guide on how to use the Ray Train Result object.

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

Kai Fricke added 4 commits August 11, 2023 17:13
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Copy link
Contributor

Choose a reason for hiding this comment

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

This is awesome, one high level suggestion for extending this is to add some more color to what the user should do with these attributes.

As a user, what can/should I do with the metrics, checkpoints, etc.? We can guide them towards common steps, such as visualizing metrics with TensorBoard, or using the checkpoint for prediction.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a bit - keeping it concise for now to not clutter the page, but happy to add more references.

doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
doc/source/train/user-guides/results.rst Outdated Show resolved Hide resolved
krfricke and others added 5 commits August 16, 2023 17:14
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Kai Fricke added 2 commits August 17, 2023 18:00
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
doc/source/train/key-concepts.rst Outdated Show resolved Hide resolved
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: Kai Fricke <krfricke@users.noreply.github.com>
@matthewdeng matthewdeng merged commit e60dc44 into ray-project:master Aug 17, 2023
18 of 21 checks passed
@krfricke krfricke deleted the doc/train/result branch August 18, 2023 11:40
vitsai pushed a commit to vitsai/ray that referenced this pull request Aug 19, 2023
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <krfricke@users.noreply.github.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <krfricke@users.noreply.github.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <krfricke@users.noreply.github.com>
Co-authored-by: matthewdeng <matthew.j.deng@gmail.com>
Signed-off-by: Victor <vctr.y.m@example.com>
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.

None yet

3 participants