No public description

PiperOrigin-RevId: 557580040

Author: cpgaffney1

README.md

@@ -17,9 +17,6 @@ asynchronous checkpointing, various types, and various storage formats.
 We aim to provide a highly customizable and composable API which maximizes
 flexibility for diverse use cases.
 
-To get started, check out our [documentation](https://github.com/google/orbax/blob/main/docs/checkpoint.md).
-
-Check out our [colab](http://colab.research.google.com/github/google/orbax/blob/main/checkpoint/orbax//checkpoint/orbax_checkpoint.ipynb) for a hands-on introduction.
 
 ## Exporting
 
@@ -33,8 +30,6 @@ Orbax also includes a serialization library for JAX users, enabling the exportin
 
 Note that `orbax-export` requires TensorFlow, but does not include it by default to allow for flexibility in version choice. If you wish to install with standard TensorFlow, please use `pip install orbax-export[all]`.
 
-To get started, check out our [documentation](https://github.com/google/orbax/blob/main/docs/export.md).
-<!-- TODO(dinghua): Add information on export library. -->
 
 ## Support
 

checkpoint/README.md

@@ -12,9 +12,5 @@ asynchronous checkpointing, various types, and various storage formats.
 We aim to provide a highly customizable and composable API which maximizes
 flexibility for diverse use cases.
 
-To get started, check out our [documentation](https://github.com/google/orbax/blob/main/docs/checkpoint.md).
-
-Check out our [colab](http://colab.research.google.com/github/google/orbax/blob/main/checkpoint/orbax//checkpoint/orbax_checkpoint.ipynb) for a hands-on introduction.
-
 
 

checkpoint/orbax/checkpoint/orbax_checkpoint.ipynb

@@ -10,7 +10,7 @@
         "\n",
         "\u003ca href=\"http://colab.research.google.com/github/google/orbax/blob/main/checkpoint/orbax//checkpoint/orbax_checkpoint.ipynb\" \u003e\u003cimg src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/\u003e\u003c/a\u003e\n",
         "\n",
-        "Take a look at https://github.com/google/orbax/blob/main/docs/checkpoint.md for additional documentation on Orbax checkpointing APIs.\n",
+        "Take a look at https://orbax.readthedocs.io/en/latest/ for additional documentation on Orbax checkpointing APIs.\n",
         "\n"
       ]
     },
@@ -1046,7 +1046,7 @@
         "*   Checkpoint version compatibility where newer checkpoints may have different structures than old ones.\n",
         "*   Mappings over keys, including one-to-one, many-to-one, one-to-many, and many-to-many transformations.\n",
         "\n",
-        "The transformations library is discussed in detail [here](https://github.com/google/orbax/blob/main/docs/checkpoint.md#transformations), so we will avoid discussing all possible features and will instead focus on concrete examples.\n",
+        "The transformations library is discussed in detail [here](go/orbax/checkpoint#transformations), so we will avoid discussing all possible features and will instead focus on concrete examples.\n",
         "\n"
       ]
     },