added everything to API- Documenation

Meta-optimization · Nov 7, 2024 · c8745ca · c8745ca
1 parent 62f61c5
commit c8745ca
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/doc/l2l.utils.rst b/doc/l2l.utils.rst
@@ -24,3 +24,26 @@ ParamterGroup
     :members:
     :undoc-members:
     :show-inheritance:
+
+Environment
+-------------
+
+.. autoclass:: l2l.utils.environment.Environment
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Experiment
+-------------
+
+.. autoclass:: l2l.utils.experiment.Experiment
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Runner 
+-------------
+.. autoclass:: l2l.utils.runner.Runner
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/l2l/utils/experiment.py b/l2l/utils/experiment.py
@@ -56,6 +56,7 @@ def prepare_experiment(self, **kwargs):
            Default runner parameters are:
             - srun: ""
             - exec: "python3 + self.paths.simulation_path/run_optimizee.py"
+            - max_workers: 32
             - work_path: self.paths.root_dir_path,
             - paths_obj: self.paths
         """