From 497df9043ec3519daef5e3aefc122ac46f773592 Mon Sep 17 00:00:00 2001 From: Adam Cogdell Date: Mon, 28 Apr 2025 14:11:36 -0700 Subject: [PATCH] Re-organize OCP v0 and v1 docs directory structure. PiperOrigin-RevId: 752442703 --- .../checkpoint/{v1 => }/orbax_intro.ipynb | 0 .../checkpoint/{ => v0}/api_refactor.ipynb | 2 +- .../{ => v0}/async_checkpointing.ipynb | 0 .../{ => v0}/checkpoint_format.ipynb | 0 .../{ => v0}/checkpointing_pytrees.ipynb | 2 +- .../checkpoint/{ => v0}/debug_guide.ipynb | 0 .../{ => v0}/optimized_checkpointing.ipynb | 0 .../{ => v0}/orbax_checkpoint_101.ipynb | 4 +-- .../orbax_checkpoint_api_overview.ipynb | 2 +- .../{ => v0}/preemption_checkpointing.ipynb | 0 .../checkpoint/{ => v0}/transformations.ipynb | 2 +- docs/index.rst | 36 +++++++++---------- 12 files changed, 24 insertions(+), 24 deletions(-) rename docs/guides/checkpoint/{v1 => }/orbax_intro.ipynb (100%) rename docs/guides/checkpoint/{ => v0}/api_refactor.ipynb (98%) rename docs/guides/checkpoint/{ => v0}/async_checkpointing.ipynb (100%) rename docs/guides/checkpoint/{ => v0}/checkpoint_format.ipynb (100%) rename docs/guides/checkpoint/{ => v0}/checkpointing_pytrees.ipynb (99%) rename docs/guides/checkpoint/{ => v0}/debug_guide.ipynb (100%) rename docs/guides/checkpoint/{ => v0}/optimized_checkpointing.ipynb (100%) rename docs/guides/checkpoint/{ => v0}/orbax_checkpoint_101.ipynb (98%) rename docs/guides/checkpoint/{ => v0}/orbax_checkpoint_api_overview.ipynb (99%) rename docs/guides/checkpoint/{ => v0}/preemption_checkpointing.ipynb (100%) rename docs/guides/checkpoint/{ => v0}/transformations.ipynb (98%) diff --git a/docs/guides/checkpoint/v1/orbax_intro.ipynb b/docs/guides/checkpoint/orbax_intro.ipynb similarity index 100% rename from docs/guides/checkpoint/v1/orbax_intro.ipynb rename to docs/guides/checkpoint/orbax_intro.ipynb diff --git a/docs/guides/checkpoint/api_refactor.ipynb b/docs/guides/checkpoint/v0/api_refactor.ipynb similarity index 98% rename from docs/guides/checkpoint/api_refactor.ipynb rename to docs/guides/checkpoint/v0/api_refactor.ipynb index f1890bed9..3ad62f885 100644 --- a/docs/guides/checkpoint/api_refactor.ipynb +++ b/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/docs/guides/checkpoint/async_checkpointing.ipynb b/docs/guides/checkpoint/v0/async_checkpointing.ipynb similarity index 100% rename from docs/guides/checkpoint/async_checkpointing.ipynb rename to docs/guides/checkpoint/v0/async_checkpointing.ipynb diff --git a/docs/guides/checkpoint/checkpoint_format.ipynb b/docs/guides/checkpoint/v0/checkpoint_format.ipynb similarity index 100% rename from docs/guides/checkpoint/checkpoint_format.ipynb rename to docs/guides/checkpoint/v0/checkpoint_format.ipynb diff --git a/docs/guides/checkpoint/checkpointing_pytrees.ipynb b/docs/guides/checkpoint/v0/checkpointing_pytrees.ipynb similarity index 99% rename from docs/guides/checkpoint/checkpointing_pytrees.ipynb rename to docs/guides/checkpoint/v0/checkpointing_pytrees.ipynb index 51507c538..84c9bc7ba 100644 --- a/docs/guides/checkpoint/checkpointing_pytrees.ipynb +++ b/docs/guides/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 b/docs/guides/checkpoint/v0/debug_guide.ipynb similarity index 100% rename from docs/guides/checkpoint/debug_guide.ipynb rename to docs/guides/checkpoint/v0/debug_guide.ipynb diff --git a/docs/guides/checkpoint/optimized_checkpointing.ipynb b/docs/guides/checkpoint/v0/optimized_checkpointing.ipynb similarity index 100% rename from docs/guides/checkpoint/optimized_checkpointing.ipynb rename to docs/guides/checkpoint/v0/optimized_checkpointing.ipynb diff --git a/docs/guides/checkpoint/orbax_checkpoint_101.ipynb b/docs/guides/checkpoint/v0/orbax_checkpoint_101.ipynb similarity index 98% rename from docs/guides/checkpoint/orbax_checkpoint_101.ipynb rename to docs/guides/checkpoint/v0/orbax_checkpoint_101.ipynb index c7b12fda2..909c04430 100644 --- a/docs/guides/checkpoint/orbax_checkpoint_101.ipynb +++ b/docs/guides/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/docs/guides/checkpoint/orbax_checkpoint_api_overview.ipynb b/docs/guides/checkpoint/v0/orbax_checkpoint_api_overview.ipynb similarity index 99% rename from docs/guides/checkpoint/orbax_checkpoint_api_overview.ipynb rename to docs/guides/checkpoint/v0/orbax_checkpoint_api_overview.ipynb index a12e38f45..c202a6707 100644 --- a/docs/guides/checkpoint/orbax_checkpoint_api_overview.ipynb +++ b/docs/guides/checkpoint/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/docs/guides/checkpoint/preemption_checkpointing.ipynb b/docs/guides/checkpoint/v0/preemption_checkpointing.ipynb similarity index 100% rename from docs/guides/checkpoint/preemption_checkpointing.ipynb rename to docs/guides/checkpoint/v0/preemption_checkpointing.ipynb diff --git a/docs/guides/checkpoint/transformations.ipynb b/docs/guides/checkpoint/v0/transformations.ipynb similarity index 98% rename from docs/guides/checkpoint/transformations.ipynb rename to docs/guides/checkpoint/v0/transformations.ipynb index 50b0b1a30..85c2b17a8 100644 --- a/docs/guides/checkpoint/transformations.ipynb +++ b/docs/guides/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 index dc82be8df..be73cf330 100644 --- 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