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

[AIR/Docs] Small improvements to Train user guide #26577

Merged
merged 4 commits into from
Jul 16, 2022

Conversation

Yard1
Copy link
Member

@Yard1 Yard1 commented Jul 14, 2022

Signed-off-by: Antoni Baum [email protected]

Why are these changes needed?

Train User Guide:

  • Expands the Results section
  • Combines reporting and checkpointing sections (both making use of session)
  • Moving the Ray Datasets section up
  • Adding some extra links and references

Also fixes typo of Results -> Result in a few places.

This is intended to be just an iterative improvement to the Train user guide. Target structure still needs to be decided on.

Related issue number

Checks

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

Signed-off-by: Antoni Baum <[email protected]>
doc/source/train/user_guide.rst Outdated Show resolved Hide resolved
doc/source/train/user_guide.rst Outdated Show resolved Hide resolved
doc/source/train/user_guide.rst Outdated Show resolved Hide resolved
doc/source/train/user_guide.rst Outdated Show resolved Hide resolved
doc/source/train/user_guide.rst Show resolved Hide resolved
doc/source/train/user_guide.rst Show resolved Hide resolved
doc/source/train/user_guide.rst Outdated Show resolved Hide resolved
@ericl ericl added the air label Jul 16, 2022
@richardliaw richardliaw merged commit fb6f3cf into ray-project:master Jul 16, 2022
xwjiang2010 pushed a commit to xwjiang2010/ray that referenced this pull request Jul 19, 2022
Stefan-1313 pushed a commit to Stefan-1313/ray_mod that referenced this pull request Aug 18, 2022
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.

5 participants