From 43acd118a34d299a1f1ab70678756cc83a9c5c59 Mon Sep 17 00:00:00 2001 From: ASEM000 Date: Thu, 11 Apr 2024 23:59:12 +0900 Subject: [PATCH] move surgery to recipes --- docs/API/sepes.rst | 2 +- docs/core_guides.rst | 1 - docs/index.rst | 2 +- ...ore]surgery.ipynb => [recipes]surgery.ipynb} | 0 docs/recipes.rst | 13 ------------- docs/tree_recipes.rst | 17 +++++++++++++++++ 6 files changed, 19 insertions(+), 16 deletions(-) rename docs/notebooks/{[guides][core]surgery.ipynb => [recipes]surgery.ipynb} (100%) delete mode 100644 docs/recipes.rst create mode 100644 docs/tree_recipes.rst diff --git a/docs/API/sepes.rst b/docs/API/sepes.rst index 6e705be..bbdab9b 100644 --- a/docs/API/sepes.rst +++ b/docs/API/sepes.rst @@ -2,7 +2,7 @@ ============================= .. note:: - `sepes `_ API is fully re-exported under the ``serket`` namespace. + `sepes `_ for tree API is fully re-exported under the ``serket`` namespace. `Check the docs `_ for full details. .. toctree:: diff --git a/docs/core_guides.rst b/docs/core_guides.rst index 4b000c6..f79e208 100644 --- a/docs/core_guides.rst +++ b/docs/core_guides.rst @@ -6,7 +6,6 @@ :caption: Core guides :maxdepth: 1 - notebooks/[guides][core]surgery notebooks/[guides][core]checkpointing notebooks/[guides][core]distributed_training notebooks/[guides][core]mixed_precision diff --git a/docs/index.rst b/docs/index.rst index 9582aba..f876c82 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,7 +64,7 @@ Install from github:: core_guides other_guides interoperability - recipes + tree_recipes .. currentmodule:: serket diff --git a/docs/notebooks/[guides][core]surgery.ipynb b/docs/notebooks/[recipes]surgery.ipynb similarity index 100% rename from docs/notebooks/[guides][core]surgery.ipynb rename to docs/notebooks/[recipes]surgery.ipynb diff --git a/docs/recipes.rst b/docs/recipes.rst deleted file mode 100644 index 526ba69..0000000 --- a/docs/recipes.rst +++ /dev/null @@ -1,13 +0,0 @@ -🍳 Recipes ------------ - - -.. toctree:: - :caption: recipes - :maxdepth: 1 - - notebooks/[recipes]fields - notebooks/[recipes]intermediates - notebooks/[recipes]misc - notebooks/[recipes]sharing - notebooks/[recipes]transformations \ No newline at end of file diff --git a/docs/tree_recipes.rst b/docs/tree_recipes.rst new file mode 100644 index 0000000..18da62e --- /dev/null +++ b/docs/tree_recipes.rst @@ -0,0 +1,17 @@ +🍳 Tree recipes +---------------- + +.. note:: + `sepes `_ for tree API is fully re-exported under the ``serket`` namespace. + `Check the docs `_ for full details. + +.. toctree:: + :caption: recipes + :maxdepth: 1 + + notebooks/[recipes]surgery + notebooks/[recipes]fields + notebooks/[recipes]intermediates + notebooks/[recipes]misc + notebooks/[recipes]sharing + notebooks/[recipes]transformations \ No newline at end of file