Update documentation

slaclab · Nov 9, 2023 · 94b7824 · 94b7824
1 parent ff4395e
commit 94b7824
Show file tree

Hide file tree

Showing 9 changed files with 630 additions and 884 deletions.
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/models.md b/docs/models.md
@@ -1,8 +1,21 @@
 # Models
 
-::: lume_model.models
-    selection:
+::: lume_model.base
+    options:
         members:
-            - BaseModel
-    rendering:
-        show_root_heading: false
+            - LUMEBaseModel
+
+::: lume_model.models.torch_model
+    options:
+        members:
+            - TorchModel
+
+::: lume_model.models.torch_module
+    options:
+        members:
+            - TorchModule
+
+::: lume_model.models.keras_model
+    options:
+        members:
+            - KerasModel
diff --git a/docs/utils.md b/docs/utils.md
@@ -1,5 +1,8 @@
 # Utilities
 
 ::: lume_model.utils
-    rendering:
-        show_root_heading: false
+    options:
+        members:
+            - variables_as_yaml
+            - variables_from_dict
+            - variables_from_yaml
diff --git a/docs/variables.md b/docs/variables.md
@@ -1,14 +1,11 @@
 # Variables
 
 ::: lume_model.variables
-    selection:
+    options:
         members:
+            - Variable
+            - ScalarVariable
+            - InputVariable
+            - OutputVariable
             - ScalarInputVariable
             - ScalarOutputVariable
-            - ImageInputVariable
-            - ImageOutputVariable
-            - ArrayInputVariable
-            - ArrayOutputVariable
-            - TableVariable
-    rendering:
-        show_source: true
diff --git a/lume_model/base.py b/lume_model/base.py
@@ -348,7 +348,6 @@ def json(self, **kwargs) -> str:
         result = self.to_json(**kwargs)
         config = json.loads(result)
         config = {"model_class": self.__class__.__name__} | config
-
         return json.dumps(config)
 
     def yaml(