Updating Documentations

erfanzar · Jul 16, 2024 · 067c50b · 067c50b
1 parent 60229e3
commit 067c50b
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 26 deletions.
diff --git 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
 
diff --git 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
@@ -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
diff --git a/docs/api_docs/xrapture.tracer.rst → docs/api_docs/core.errors.rst b/docs/api_docs/xrapture.tracer.rst → 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
@@ -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
@@ -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
diff --git a/docs/api_docs/xrapture.xrapture.rst b/docs/api_docs/xrapture.xrapture.rst