google · copybara-service · Apr 28, 2025
diff --git a/docs/guides/checkpoint/v1/orbax_intro.ipynb → docs/guides/checkpoint/orbax_intro.ipynb b/docs/guides/checkpoint/v1/orbax_intro.ipynb → docs/guides/checkpoint/orbax_intro.ipynb
diff --git a/docs/guides/checkpoint/api_refactor.ipynb → docs/guides/checkpoint/v0/api_refactor.ipynb b/docs/guides/checkpoint/api_refactor.ipynb → docs/guides/checkpoint/v0/api_refactor.ipynb
@@ -43,7 +43,7 @@
         "id": "iabvwEt5je5e"
       },
       "source": [
-        "For further information on how to use the new API, see the [introductory tutorial](https://orbax.readthedocs.io/en/latest/guides/checkpoint/orbax_checkpoint_101.html) and the [API Overview](https://orbax.readthedocs.io/en/latest/guides/checkpoint/orbax_checkpoint_api_overview.html)."
+        "For further information on how to use the new API, see the [introductory tutorial](https://orbax.readthedocs.io/en/latest/guides/checkpoint/v0/orbax_checkpoint_101.html) and the [API Overview](https://orbax.readthedocs.io/en/latest/guides/checkpoint/v0/orbax_checkpoint_api_overview.html)."
       ]
     },
     {

diff --git a/...ides/checkpoint/async_checkpointing.ipynb → ...s/checkpoint/v0/async_checkpointing.ipynb b/...ides/checkpoint/async_checkpointing.ipynb → ...s/checkpoint/v0/async_checkpointing.ipynb
diff --git a/...guides/checkpoint/checkpoint_format.ipynb → ...des/checkpoint/v0/checkpoint_format.ipynb b/...guides/checkpoint/checkpoint_format.ipynb → ...des/checkpoint/v0/checkpoint_format.ipynb
diff --git a/...es/checkpoint/checkpointing_pytrees.ipynb → ...checkpoint/v0/checkpointing_pytrees.ipynb b/...es/checkpoint/checkpointing_pytrees.ipynb → ...checkpoint/v0/checkpointing_pytrees.ipynb
@@ -706,7 +706,7 @@
         "id": "MMPpjjErDzTT"
       },
       "source": [
-        "`PyTreeCheckpointHandler` also provides options to perform transformations when restoring. This is useful when your target tree has a different structure than your checkpoint tree. This allows you to avoid loading some keys or rename other keys. Full details are available at the [Transformations](https://orbax.readthedocs.io/en/latest/guides/checkpoint/transformations.html) page."
+        "`PyTreeCheckpointHandler` also provides options to perform transformations when restoring. This is useful when your target tree has a different structure than your checkpoint tree. This allows you to avoid loading some keys or rename other keys. Full details are available at the [Transformations](https://orbax.readthedocs.io/en/latest/guides/checkpoint/v0/transformations.html) page."
       ]
     },
     {

diff --git a/docs/guides/checkpoint/debug_guide.ipynb → docs/guides/checkpoint/v0/debug_guide.ipynb b/docs/guides/checkpoint/debug_guide.ipynb → docs/guides/checkpoint/v0/debug_guide.ipynb
diff --git a/.../checkpoint/optimized_checkpointing.ipynb → ...eckpoint/v0/optimized_checkpointing.ipynb b/.../checkpoint/optimized_checkpointing.ipynb → ...eckpoint/v0/optimized_checkpointing.ipynb
diff --git a/...des/checkpoint/orbax_checkpoint_101.ipynb → .../checkpoint/v0/orbax_checkpoint_101.ipynb b/...des/checkpoint/orbax_checkpoint_101.ipynb → .../checkpoint/v0/orbax_checkpoint_101.ipynb
@@ -15,7 +15,7 @@
         "id": "1Ik2ARq4JaL3"
       },
       "source": [
-        "This page serves as a simple overview of common tasks that you may wish to accomplish with Orbax. For more in-depth documentation of the API's, see [API Overview](https://orbax.readthedocs.io/en/latest/guides/checkpoint/orbax_checkpoint_api_overview.html)."
+        "This page serves as a simple overview of common tasks that you may wish to accomplish with Orbax. For more in-depth documentation of the API's, see [API Overview](https://orbax.readthedocs.io/en/latest/guides/checkpoint/v0/orbax_checkpoint_api_overview.html)."
       ]
     },
     {
@@ -33,7 +33,7 @@
         "id": "VyfEdKvwswys"
       },
       "source": [
-        "The following example shows how you can synchronously save and restore a PyTree. See [Checkpointing PyTrees](https://orbax.readthedocs.io/en/latest/guides/checkpoint/checkpointing_pytrees.html) for more detail.\n",
+        "The following example shows how you can synchronously save and restore a PyTree. See [Checkpointing PyTrees](https://orbax.readthedocs.io/en/latest/guides/checkpoint/v0/checkpointing_pytrees.html) for more detail.\n",
         "\n"
       ]
     },

diff --git a/...point/orbax_checkpoint_api_overview.ipynb → ...nt/v0/orbax_checkpoint_api_overview.ipynb b/...point/orbax_checkpoint_api_overview.ipynb → ...nt/v0/orbax_checkpoint_api_overview.ipynb
@@ -361,7 +361,7 @@
       "source": [
         "There are some when the mapping between items and respective `CheckpointHandler`s need to be provided at the time of creating a `CheckpointManager` instance.\n",
         "\n",
-        "CheckpointManager constructor argument, `item_handlers`, enables to resolve those scenarios. Please see [Using the Refactored CheckpointManager API](https://orbax.readthedocs.io/en/latest/guides/checkpoint/api_refactor.html) for the details.\n",
+        "CheckpointManager constructor argument, `item_handlers`, enables to resolve those scenarios. Please see [Using the Refactored CheckpointManager API](https://orbax.readthedocs.io/en/latest/guides/checkpoint/v0/api_refactor.html) for the details.\n",
         "\n"
       ]
     },

diff --git a/...checkpoint/preemption_checkpointing.ipynb → ...ckpoint/v0/preemption_checkpointing.ipynb b/...checkpoint/preemption_checkpointing.ipynb → ...ckpoint/v0/preemption_checkpointing.ipynb
diff --git a/docs/guides/checkpoint/transformations.ipynb → ...uides/checkpoint/v0/transformations.ipynb b/docs/guides/checkpoint/transformations.ipynb → ...uides/checkpoint/v0/transformations.ipynb
@@ -16,7 +16,7 @@
       "cell_type": "markdown",
       "source": [
         "\u003cdiv class=\"alert alert-block alert-warning\"\u003e\n",
-        "\u003cb\u003eNote:\u003c/b\u003e The transformations library has been deprecated. Please refer to the \u003ca href=\"https://orbax.readthedocs.io/en/latest/guides/checkpoint/checkpointing_pytrees.html#partial-restore\"\u003ePartial Restoration\u003c/a\u003e documentation for information on how to restore only part of a PyTree within a checkpoint.\n",
+        "\u003cb\u003eNote:\u003c/b\u003e The transformations library has been deprecated. Please refer to the \u003ca href=\"https://orbax.readthedocs.io/en/latest/guides/checkpoint/v0/checkpointing_pytrees.html#partial-restore\"\u003ePartial Restoration\u003c/a\u003e documentation for information on how to restore only part of a PyTree within a checkpoint.\n",
         "\u003c/div\u003e"
       ]
     },

diff --git a/docs/index.rst b/docs/index.rst
@@ -71,16 +71,16 @@ Install from GitHub using the following.
    :caption: Checkpointing
 
    guides/checkpoint/orbax_checkpoint_announcements
-   guides/checkpoint/orbax_checkpoint_101
-   guides/checkpoint/orbax_checkpoint_api_overview
-   guides/checkpoint/api_refactor
-   guides/checkpoint/checkpointing_pytrees
-   guides/checkpoint/checkpoint_format
-   guides/checkpoint/optimized_checkpointing
-   guides/checkpoint/transformations
-   guides/checkpoint/preemption_checkpointing
+   guides/checkpoint/v0/orbax_checkpoint_101
+   guides/checkpoint/v0/orbax_checkpoint_api_overview
+   guides/checkpoint/v0/api_refactor
+   guides/checkpoint/v0/checkpointing_pytrees
+   guides/checkpoint/v0/checkpoint_format
+   guides/checkpoint/v0/optimized_checkpointing
+   guides/checkpoint/v0/transformations
+   guides/checkpoint/v0/preemption_checkpointing
    guides/checkpoint/async_checkpointing
-   guides/checkpoint/debug_guide
+   guides/checkpoint/v0/debug_guide
    api_reference/checkpoint
 
 .. toctree::
@@ -108,56 +108,56 @@ Checkpointing
 
       .. card:: Getting Started
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/orbax_checkpoint_101.html
+         :link: guides/checkpoint/v0/orbax_checkpoint_101.html
 
    .. grid-item::
       :columns: 6 6 6 4
 
       .. card:: API Overview
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/orbax_checkpoint_api_overview.html
+         :link: guides/checkpoint/v0/orbax_checkpoint_api_overview.html
 
    .. grid-item::
       :columns: 6 6 6 4
 
       .. card:: API Refactor
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/api_refactor.html
+         :link: guides/checkpoint/v0/api_refactor.html
 
    .. grid-item::
       :columns: 6 6 6 4
 
       .. card:: Checkpointing PyTrees of Arrays
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/checkpointing_pytrees.html
+         :link: guides/checkpoint/v0/checkpointing_pytrees.html
 
    .. grid-item::
       :columns: 6 6 6 4
 
       .. card:: Checkpoint Format Guide
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/checkpoint_format.html
+         :link: guides/checkpoint/v0/checkpoint_format.html
 
    .. grid-item::
       :columns: 6 6 6 4
 
       .. card:: Optimized Checkpointing
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/optimized_checkpointing.html
+         :link: guides/checkpoint/v0/optimized_checkpointing.html
 
    .. grid-item::
       :columns: 6 6 6 4
 
       .. card:: Transformations
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/transformations.html
+         :link: guides/checkpoint/v0/transformations.html
 
    .. grid-item::
       :columns: 6 6 6 4
 
       .. card:: Preemption Tolerance
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/preemption_checkpointing.html
+         :link: guides/checkpoint/v0/preemption_checkpointing.html
 
    .. grid-item::
       :columns: 6 6 6 4
@@ -171,7 +171,7 @@ Checkpointing
 
       .. card:: Debug Guide
          :class-card: sd-text-black sd-bg-light
-         :link: guides/checkpoint/debug_guide.html
+         :link: guides/checkpoint/v0/debug_guide.html
 
    .. grid-item::
       :columns: 6 6 6 4