[docs] Add auto API generator (#11)

* [docs] Add auto API generator * Remove autogen .rst files
chaobrain · Dec 13, 2024 · 9e29fed · 9e29fed
1 parent c6bdef4
commit 9e29fed
Show file tree

Hide file tree

Showing 11 changed files with 522 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,4 +30,10 @@ related-projects.md
 docs/**/*.dat
 docs/**/*.npz
 
-.DS_Store
+.DS_Store
+docs/apis/
+!docs/apis/pinnx.rst
+!docs/apis/pinnx.callbacks.rst
+!docs/apis/pinnx.fnspace.rst
+!docs/apis/pinnx.grad.rst
+!docs/apis/pinnx.metrics.rst
diff --git a/docs/_templates/classtemplate.rst b/docs/_templates/classtemplate.rst
@@ -0,0 +1,9 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autoclass:: {{ name }}
+    :members:
diff --git a/docs/apis/pinnx.callbacks.rst b/docs/apis/pinnx.callbacks.rst
@@ -0,0 +1,26 @@
+``pinnx.callbacks`` module
+==========================
+
+.. currentmodule:: pinnx.callbacks
+.. automodule:: pinnx.callbacks
+
+Callbacks
+---------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   Callback
+   CallbackList
+   ModelCheckpoint
+   EarlyStopping
+   Timer
+   DropoutUncertainty
+   VariableValue
+   OperatorPredictor
+   MovieDumper
+   PDEPointResampler
+
+
diff --git a/docs/apis/pinnx.fnspace.rst b/docs/apis/pinnx.fnspace.rst
@@ -0,0 +1,23 @@
+``pinnx.fnspace`` module
+========================
+
+.. currentmodule:: pinnx.fnspace
+.. automodule:: pinnx.fnspace
+
+Function Space
+--------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   wasserstein2
+   FunctionSpace
+   PowerSeries
+   Chebyshev
+   GRF
+   GRF_KL
+   GRF2D
+
+
diff --git a/docs/apis/pinnx.grad.rst b/docs/apis/pinnx.grad.rst
@@ -0,0 +1,19 @@
+``pinnx.grad`` module
+=====================
+
+.. currentmodule:: pinnx.grad
+.. automodule:: pinnx.grad
+
+Automatic Differentiation
+-------------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   jacobian
+   hessian
+   gradient
+
+
diff --git a/docs/apis/pinnx.metrics.rst b/docs/apis/pinnx.metrics.rst
@@ -0,0 +1,24 @@
+``pinnx.metrics`` module
+========================
+
+.. currentmodule:: pinnx.metrics
+.. automodule:: pinnx.metrics
+
+Metrics
+-------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   accuracy
+   l2_relative_error
+   nanl2_relative_error
+   mean_l2_relative_error
+   mean_squared_error
+   mean_absolute_percentage_error
+   max_absolute_percentage_error
+   absolute_percentage_error_std
+
+
diff --git a/docs/apis/pinnx.rst b/docs/apis/pinnx.rst
@@ -0,0 +1,17 @@
+``pinnx`` module
+================
+
+.. currentmodule:: pinnx 
+.. automodule:: pinnx 
+
+Trainer
+-------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   Trainer
+
+