[DOC] Add a v1 to v2 migration guide - #2349
Open
echo-xiao wants to merge 7 commits into
Open
Conversation
echo-xiao
requested review from
benHeid,
fkiraly,
jdb78 and
phoeenniixx
as code owners
July 21, 2026 06:33
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2349 +/- ##
=======================================
Coverage ? 87.34%
=======================================
Files ? 171
Lines ? 10080
Branches ? 0
=======================================
Hits ? 8804
Misses ? 1276
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…ide (rename to migration_v1_to_v2, move under tutorials)
3 tasks
phoeenniixx
reviewed
Jul 25, 2026
| Tutorials <tutorials_v2> | ||
|
|
||
| .. seealso:: | ||
| Porting a v1 model implementation to v2? See :doc:`migration_v1_to_v2`. |
Member
There was a problem hiding this comment.
this guide should be in the boxes at the top of every page which shows v2 is in works. WHat do you think?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds docs/source/migration_v2.rst (a v1 to v2 migration guide) and registers it in the api_v2 toctree. Addresses #2288, part of the v2 docs umbrella #2304. Includes a v1-to-v2 concept mapping table, an end-to-end TFT before/after example (v1, v2 package wrapper, v2 explicit layers), a what-stays-the-same section, and a whats-new section with an auto-generated model-overview table. Example code runs on load_toydata and the docs build cleanly.