Fix docs?

metatensor · Sep 12, 2024 · 55847c7 · 55847c7
1 parent 498e566
commit 55847c7
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 10 deletions.
diff --git a/docs/src/dev-docs/utils/additive/composition.rst b/docs/src/dev-docs/utils/additive/composition.rst
@@ -0,0 +1,7 @@
+Composition model
+#################
+
+.. automodule:: metatrain.utils.additive.composition
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/src/dev-docs/utils/additive/index.rst b/docs/src/dev-docs/utils/additive/index.rst
@@ -0,0 +1,12 @@
+Data
+====
+
+API for handling additive models in ``metatrain``. These are models that
+can be added to one or more architectures.
+
+.. toctree::
+   :maxdepth: 1
+
+   remove_additive
+   composition
+   zbl
diff --git a/docs/src/dev-docs/utils/additive/remove_additive.rst b/docs/src/dev-docs/utils/additive/remove_additive.rst
@@ -0,0 +1,7 @@
+Removing additive contributions
+###############################
+
+.. automodule:: metatrain.utils.additive.remove
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/src/dev-docs/utils/additive/zbl.rst b/docs/src/dev-docs/utils/additive/zbl.rst
@@ -0,0 +1,7 @@
+ZBL short-range potential
+#########################
+
+.. automodule:: metatrain.utils.additive.zbl
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/src/dev-docs/utils/composition.rst b/docs/src/dev-docs/utils/composition.rst
diff --git a/docs/src/dev-docs/utils/index.rst b/docs/src/dev-docs/utils/index.rst
@@ -6,9 +6,9 @@ This is the API for the ``utils`` module of ``metatrain``.
 .. toctree::
    :maxdepth: 1
 
+   additive/index
    data/index
    architectures
-   composition
    devices
    dtype
    errors

diff --git a/tests/resources/options.yaml b/tests/resources/options.yaml
@@ -1,9 +1,10 @@
 seed: 42
 
 architecture:
-  name: experimental.nanopet
+  name: experimental.soap_bpnn
   training:
-    batch_size: 8
+    batch_size: 2
+    num_epochs: 1
 
 training_set:
   systems: