From 067c50b4a58cd71214ad6a697467de953d84886e Mon Sep 17 00:00:00 2001 From: erfanzar Date: Tue, 16 Jul 2024 11:09:26 -0700 Subject: [PATCH] Updating Documentations --- docs/api_docs/APIs.rst | 2 +- docs/api_docs/Core.rst | 1 + docs/api_docs/Lora.rst | 8 ++++++++ docs/api_docs/Xrapture.rst | 9 --------- docs/api_docs/{xrapture.tracer.rst => core.errors.rst} | 4 ++-- docs/api_docs/lora.lora_core.rst | 7 +++++++ docs/api_docs/lora.rapture.rst | 7 +++++++ docs/api_docs/xrapture.implicit_array.rst | 7 ------- docs/api_docs/xrapture.xrapture.rst | 7 ------- 9 files changed, 26 insertions(+), 26 deletions(-) create mode 100644 docs/api_docs/Lora.rst delete mode 100644 docs/api_docs/Xrapture.rst rename docs/api_docs/{xrapture.tracer.rst => core.errors.rst} (56%) create mode 100644 docs/api_docs/lora.lora_core.rst create mode 100644 docs/api_docs/lora.rapture.rst delete mode 100644 docs/api_docs/xrapture.implicit_array.rst delete mode 100644 docs/api_docs/xrapture.xrapture.rst diff --git a/docs/api_docs/APIs.rst b/docs/api_docs/APIs.rst index cdad4e6..e843afa 100644 --- a/docs/api_docs/APIs.rst +++ b/docs/api_docs/APIs.rst @@ -9,10 +9,10 @@ FJFormer APIs 🔮 Core Functions Linen + Lora Monitor Optimizers Pallas Operations Sharding Utils - Xrapture \ No newline at end of file diff --git a/docs/api_docs/Core.rst b/docs/api_docs/Core.rst index d45c7e0..4e0fc38 100644 --- a/docs/api_docs/Core.rst +++ b/docs/api_docs/Core.rst @@ -8,3 +8,4 @@ Core core.types core.utilities core.implicit_array + core.errors diff --git a/docs/api_docs/Lora.rst b/docs/api_docs/Lora.rst new file mode 100644 index 0000000..186e3bd --- /dev/null +++ b/docs/api_docs/Lora.rst @@ -0,0 +1,8 @@ +Lora +==== + +.. toctree:: + :maxdepth: 2 + + lora.rapture + lora.lora_core diff --git a/docs/api_docs/Xrapture.rst b/docs/api_docs/Xrapture.rst deleted file mode 100644 index 883979c..0000000 --- a/docs/api_docs/Xrapture.rst +++ /dev/null @@ -1,9 +0,0 @@ -Xrapture -======== - -.. toctree:: - :maxdepth: 2 - - xrapture.tracer - xrapture.xrapture - xrapture.implicit_array diff --git a/docs/api_docs/xrapture.tracer.rst b/docs/api_docs/core.errors.rst similarity index 56% rename from docs/api_docs/xrapture.tracer.rst rename to docs/api_docs/core.errors.rst index 2afa588..641af23 100644 --- a/docs/api_docs/xrapture.tracer.rst +++ b/docs/api_docs/core.errors.rst @@ -1,7 +1,7 @@ -tracer package +errors package ============== -.. automodule:: fjformer.xrapture.tracer +.. automodule:: fjformer.core.errors :members: :undoc-members: :show-inheritance: diff --git a/docs/api_docs/lora.lora_core.rst b/docs/api_docs/lora.lora_core.rst new file mode 100644 index 0000000..eaa2acf --- /dev/null +++ b/docs/api_docs/lora.lora_core.rst @@ -0,0 +1,7 @@ +lora_core package +================= + +.. automodule:: fjformer.lora.lora_core + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_docs/lora.rapture.rst b/docs/api_docs/lora.rapture.rst new file mode 100644 index 0000000..d855764 --- /dev/null +++ b/docs/api_docs/lora.rapture.rst @@ -0,0 +1,7 @@ +rapture package +=============== + +.. automodule:: fjformer.lora.rapture + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api_docs/xrapture.implicit_array.rst b/docs/api_docs/xrapture.implicit_array.rst deleted file mode 100644 index 1a14558..0000000 --- a/docs/api_docs/xrapture.implicit_array.rst +++ /dev/null @@ -1,7 +0,0 @@ -implicit_array package -====================== - -.. automodule:: fjformer.xrapture.implicit_array - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/api_docs/xrapture.xrapture.rst b/docs/api_docs/xrapture.xrapture.rst deleted file mode 100644 index f6283f1..0000000 --- a/docs/api_docs/xrapture.xrapture.rst +++ /dev/null @@ -1,7 +0,0 @@ -xrapture package -================ - -.. automodule:: fjformer.xrapture.xrapture - :members: - :undoc-members: - :show-inheritance: