Skip to content

[docs][train][minor] add links to train v2 migration guide in the Train API pages#51924

Merged
matthewdeng merged 4 commits intomasterfrom
docs/link-to-trainv2-migration-guide
Apr 10, 2025
Merged

[docs][train][minor] add links to train v2 migration guide in the Train API pages#51924
matthewdeng merged 4 commits intomasterfrom
docs/link-to-trainv2-migration-guide

Conversation

@crypdick
Copy link
Copy Markdown
Contributor

@crypdick crypdick commented Apr 2, 2025

Why are these changes needed?

The Train v1 and v2 API docs have a notice about the pending v2 release. this PR adds links to the migration guide.

Related issue number

N/A

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

crypdick added 2 commits April 2, 2025 10:56
Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
@crypdick crypdick added docs An issue or change related to documentation train Ray Train Related Issue labels Apr 2, 2025
Copy link
Copy Markdown
Contributor

@justinvyu justinvyu left a comment

Choose a reason for hiding this comment

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

Thanks

@justinvyu justinvyu enabled auto-merge (squash) April 2, 2025 18:05
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Apr 2, 2025
@github-actions github-actions bot disabled auto-merge April 3, 2025 23:07
@matthewdeng matthewdeng merged commit dec6d80 into master Apr 10, 2025
5 checks passed
@matthewdeng matthewdeng deleted the docs/link-to-trainv2-migration-guide branch April 10, 2025 01:11
han-steve pushed a commit to han-steve/ray that referenced this pull request Apr 11, 2025
…in API pages (ray-project#51924)

The Train v1 and v2 API docs have a notice about the pending v2 release.
this PR adds links to the migration guide.

---------

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>
Signed-off-by: Steve Han <stevehan2001@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-backlog docs An issue or change related to documentation go add ONLY when ready to merge, run all tests train Ray Train Related Issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants