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

[train][doc] Update Ray Train example titles #44369

Merged
merged 4 commits into from
Apr 19, 2024

Conversation

justinvyu
Copy link
Contributor

Why are these changes needed?

This makes the example titles consistent and removes unnecessary information (ex: "mnist classifier" / "fashion mnist classifier" --> "image classifier"). Also, re-iterate the main value of running these examples with Ray Train at the top of the page.

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

Signed-off-by: Justin Yu <justinvyu@anyscale.com>
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
doc/source/train/examples.yml Outdated Show resolved Hide resolved
doc/source/train/examples.yml Outdated Show resolved Hide resolved
doc/source/train/examples.yml Show resolved Hide resolved
Copy link
Member

@woshiyyya woshiyyya left a comment

Choose a reason for hiding this comment

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

Thanks for polishing the example titles.

doc/source/train/examples.yml Outdated Show resolved Hide resolved
doc/source/train/examples.yml Outdated Show resolved Hide resolved
doc/source/train/examples.yml Outdated Show resolved Hide resolved
doc/source/train/examples.yml Outdated Show resolved Hide resolved
doc/source/train/examples.yml Outdated Show resolved Hide resolved
doc/source/train/examples.yml Outdated Show resolved Hide resolved
Signed-off-by: Justin Yu <justinvyu@anyscale.com>
@justinvyu justinvyu merged commit a33d6c7 into ray-project:master Apr 19, 2024
5 checks passed
@justinvyu justinvyu deleted the fix_example_docs branch April 19, 2024 20:54
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

4 participants