Update documentation

allenanie · allenanie · commit cd7235caec15 · 2025-08-20T18:04:35.000-04:00
diff --git a/docs-mkdocs/docs/api/SUMMARY.md b/docs-mkdocs/docs/api/SUMMARY.md
@@ -0,0 +1,52 @@
+* [features](features/index.md)
+    * [mlflow](features/mlflow/index.md)
+        * [autolog](features/mlflow/autolog.md)
+    * [priority_search](features/priority_search/index.md)
+        * [examples](features/priority_search/examples.md)
+        * [priority_search](features/priority_search/priority_search.md)
+        * [sampler](features/priority_search/sampler.md)
+        * [search_template](features/priority_search/search_template.md)
+        * [utils](features/priority_search/utils.md)
+* [optimizers](optimizers/index.md)
+    * [buffers](optimizers/buffers.md)
+    * [opro](optimizers/opro.md)
+    * [opro_v2](optimizers/opro_v2.md)
+    * [optimizer](optimizers/optimizer.md)
+    * [optoprime](optimizers/optoprime.md)
+    * [optoprime_v2](optimizers/optoprime_v2.md)
+    * [optoprimemulti](optimizers/optoprimemulti.md)
+    * [textgrad](optimizers/textgrad.md)
+    * [utils](optimizers/utils.md)
+* [trace](trace/index.md)
+    * [broadcast](trace/broadcast.md)
+    * [bundle](trace/bundle.md)
+    * [containers](trace/containers.md)
+    * [errors](trace/errors.md)
+    * [iterators](trace/iterators.md)
+    * [modules](trace/modules.md)
+    * [nodes](trace/nodes.md)
+    * [operators](trace/operators.md)
+    * [projections](trace/projections/index.md)
+        * [code_projections](trace/projections/code_projections.md)
+        * [projections](trace/projections/projections.md)
+    * [propagators](trace/propagators/index.md)
+        * [graph_propagator](trace/propagators/graph_propagator.md)
+        * [propagators](trace/propagators/propagators.md)
+    * [settings](trace/settings.md)
+    * [utils](trace/utils.md)
+* [trainer](trainer/index.md)
+    * [algorithms](trainer/algorithms/index.md)
+        * [UCBsearch](trainer/algorithms/UCBsearch.md)
+        * [aggregator](trainer/algorithms/aggregator.md)
+        * [algorithm](trainer/algorithms/algorithm.md)
+        * [basic_algorithms](trainer/algorithms/basic_algorithms.md)
+        * [beamsearch_algorithm](trainer/algorithms/beamsearch_algorithm.md)
+    * [evaluators](trainer/evaluators.md)
+    * [guide](trainer/guide.md)
+    * [loader](trainer/loader.md)
+    * [loggers](trainer/loggers.md)
+    * [suggest](trainer/suggest.md)
+    * [utils](trainer/utils.md)
+* [utils](utils/index.md)
+    * [llm](utils/llm.md)
+* [version](version.md)
diff --git a/docs-mkdocs/docs/api/features/index.md b/docs-mkdocs/docs/api/features/index.md
@@ -0,0 +1,2 @@
+# opto.features
+::: opto.features
diff --git a/docs-mkdocs/docs/api/features/mlflow/autolog.md b/docs-mkdocs/docs/api/features/mlflow/autolog.md
@@ -0,0 +1,2 @@
+# opto.features.mlflow.autolog
+::: opto.features.mlflow.autolog
diff --git a/docs-mkdocs/docs/api/features/mlflow/index.md b/docs-mkdocs/docs/api/features/mlflow/index.md
@@ -0,0 +1,2 @@
+# opto.features.mlflow
+::: opto.features.mlflow
diff --git a/docs-mkdocs/docs/api/features/priority_search/examples.md b/docs-mkdocs/docs/api/features/priority_search/examples.md
@@ -0,0 +1,2 @@
+# opto.features.priority_search.examples
+::: opto.features.priority_search.examples
diff --git a/docs-mkdocs/docs/api/features/priority_search/index.md b/docs-mkdocs/docs/api/features/priority_search/index.md
@@ -0,0 +1,2 @@
+# opto.features.priority_search
+::: opto.features.priority_search
diff --git a/docs-mkdocs/docs/api/features/priority_search/priority_search.md b/docs-mkdocs/docs/api/features/priority_search/priority_search.md
@@ -0,0 +1,2 @@
+# opto.features.priority_search.priority_search
+::: opto.features.priority_search.priority_search
diff --git a/docs-mkdocs/docs/api/features/priority_search/sampler.md b/docs-mkdocs/docs/api/features/priority_search/sampler.md
@@ -0,0 +1,2 @@
+# opto.features.priority_search.sampler
+::: opto.features.priority_search.sampler
diff --git a/docs-mkdocs/docs/api/features/priority_search/search_template.md b/docs-mkdocs/docs/api/features/priority_search/search_template.md
@@ -0,0 +1,2 @@
+# opto.features.priority_search.search_template
+::: opto.features.priority_search.search_template
diff --git a/docs-mkdocs/docs/api/features/priority_search/utils.md b/docs-mkdocs/docs/api/features/priority_search/utils.md
@@ -0,0 +1,2 @@
+# opto.features.priority_search.utils
+::: opto.features.priority_search.utils
diff --git a/docs-mkdocs/docs/api/optimizers/buffers.md b/docs-mkdocs/docs/api/optimizers/buffers.md
@@ -0,0 +1,2 @@
+# opto.optimizers.buffers
+::: opto.optimizers.buffers
diff --git a/docs-mkdocs/docs/api/optimizers/index.md b/docs-mkdocs/docs/api/optimizers/index.md
@@ -0,0 +1,2 @@
+# opto.optimizers
+::: opto.optimizers
diff --git a/docs-mkdocs/docs/api/optimizers/opro.md b/docs-mkdocs/docs/api/optimizers/opro.md
@@ -0,0 +1,2 @@
+# opto.optimizers.opro
+::: opto.optimizers.opro
diff --git a/docs-mkdocs/docs/api/optimizers/opro_v2.md b/docs-mkdocs/docs/api/optimizers/opro_v2.md
@@ -0,0 +1,2 @@
+# opto.optimizers.opro_v2
+::: opto.optimizers.opro_v2
diff --git a/docs-mkdocs/docs/api/optimizers/optimizer.md b/docs-mkdocs/docs/api/optimizers/optimizer.md
@@ -0,0 +1,2 @@
+# opto.optimizers.optimizer
+::: opto.optimizers.optimizer
diff --git a/docs-mkdocs/docs/api/optimizers/optoprime.md b/docs-mkdocs/docs/api/optimizers/optoprime.md
@@ -0,0 +1,2 @@
+# opto.optimizers.optoprime
+::: opto.optimizers.optoprime
diff --git a/docs-mkdocs/docs/api/optimizers/optoprime_v2.md b/docs-mkdocs/docs/api/optimizers/optoprime_v2.md
@@ -0,0 +1,2 @@
+# opto.optimizers.optoprime_v2
+::: opto.optimizers.optoprime_v2
diff --git a/docs-mkdocs/docs/api/optimizers/optoprimemulti.md b/docs-mkdocs/docs/api/optimizers/optoprimemulti.md
@@ -0,0 +1,2 @@
+# opto.optimizers.optoprimemulti
+::: opto.optimizers.optoprimemulti
diff --git a/docs-mkdocs/docs/api/optimizers/textgrad.md b/docs-mkdocs/docs/api/optimizers/textgrad.md
@@ -0,0 +1,2 @@
+# opto.optimizers.textgrad
+::: opto.optimizers.textgrad
diff --git a/docs-mkdocs/docs/api/optimizers/utils.md b/docs-mkdocs/docs/api/optimizers/utils.md
@@ -0,0 +1,2 @@
+# opto.optimizers.utils
+::: opto.optimizers.utils
diff --git a/docs-mkdocs/docs/api/trace/broadcast.md b/docs-mkdocs/docs/api/trace/broadcast.md
@@ -0,0 +1,2 @@
+# opto.trace.broadcast
+::: opto.trace.broadcast
diff --git a/docs-mkdocs/docs/api/trace/bundle.md b/docs-mkdocs/docs/api/trace/bundle.md
@@ -0,0 +1,2 @@
+# opto.trace.bundle
+::: opto.trace.bundle
diff --git a/docs-mkdocs/docs/api/trace/containers.md b/docs-mkdocs/docs/api/trace/containers.md
@@ -0,0 +1,2 @@
+# opto.trace.containers
+::: opto.trace.containers
diff --git a/docs-mkdocs/docs/api/trace/errors.md b/docs-mkdocs/docs/api/trace/errors.md
@@ -0,0 +1,2 @@
+# opto.trace.errors
+::: opto.trace.errors
diff --git a/docs-mkdocs/docs/api/trace/index.md b/docs-mkdocs/docs/api/trace/index.md
@@ -0,0 +1,2 @@
+# opto.trace
+::: opto.trace
diff --git a/docs-mkdocs/docs/api/trace/iterators.md b/docs-mkdocs/docs/api/trace/iterators.md
@@ -0,0 +1,2 @@
+# opto.trace.iterators
+::: opto.trace.iterators
diff --git a/docs-mkdocs/docs/api/trace/modules.md b/docs-mkdocs/docs/api/trace/modules.md
@@ -0,0 +1,2 @@
+# opto.trace.modules
+::: opto.trace.modules
diff --git a/docs-mkdocs/docs/api/trace/nodes.md b/docs-mkdocs/docs/api/trace/nodes.md
@@ -0,0 +1,2 @@
+# opto.trace.nodes
+::: opto.trace.nodes
diff --git a/docs-mkdocs/docs/api/trace/operators.md b/docs-mkdocs/docs/api/trace/operators.md
@@ -0,0 +1,2 @@
+# opto.trace.operators
+::: opto.trace.operators
diff --git a/docs-mkdocs/docs/api/trace/projections/code_projections.md b/docs-mkdocs/docs/api/trace/projections/code_projections.md
@@ -0,0 +1,2 @@
+# opto.trace.projections.code_projections
+::: opto.trace.projections.code_projections
diff --git a/docs-mkdocs/docs/api/trace/projections/index.md b/docs-mkdocs/docs/api/trace/projections/index.md
@@ -0,0 +1,2 @@
+# opto.trace.projections
+::: opto.trace.projections
diff --git a/docs-mkdocs/docs/api/trace/projections/projections.md b/docs-mkdocs/docs/api/trace/projections/projections.md
@@ -0,0 +1,2 @@
+# opto.trace.projections.projections
+::: opto.trace.projections.projections
diff --git a/docs-mkdocs/docs/api/trace/propagators/graph_propagator.md b/docs-mkdocs/docs/api/trace/propagators/graph_propagator.md
@@ -0,0 +1,2 @@
+# opto.trace.propagators.graph_propagator
+::: opto.trace.propagators.graph_propagator
diff --git a/docs-mkdocs/docs/api/trace/propagators/index.md b/docs-mkdocs/docs/api/trace/propagators/index.md
@@ -0,0 +1,2 @@
+# opto.trace.propagators
+::: opto.trace.propagators
diff --git a/docs-mkdocs/docs/api/trace/propagators/propagators.md b/docs-mkdocs/docs/api/trace/propagators/propagators.md
@@ -0,0 +1,2 @@
+# opto.trace.propagators.propagators
+::: opto.trace.propagators.propagators
diff --git a/docs-mkdocs/docs/api/trace/settings.md b/docs-mkdocs/docs/api/trace/settings.md
@@ -0,0 +1,2 @@
+# opto.trace.settings
+::: opto.trace.settings
diff --git a/docs-mkdocs/docs/api/trace/utils.md b/docs-mkdocs/docs/api/trace/utils.md
@@ -0,0 +1,2 @@
+# opto.trace.utils
+::: opto.trace.utils
diff --git a/docs-mkdocs/docs/api/trainer/algorithms/UCBsearch.md b/docs-mkdocs/docs/api/trainer/algorithms/UCBsearch.md
@@ -0,0 +1,2 @@
+# opto.trainer.algorithms.UCBsearch
+::: opto.trainer.algorithms.UCBsearch
diff --git a/docs-mkdocs/docs/api/trainer/algorithms/aggregator.md b/docs-mkdocs/docs/api/trainer/algorithms/aggregator.md
@@ -0,0 +1,2 @@
+# opto.trainer.algorithms.aggregator
+::: opto.trainer.algorithms.aggregator
diff --git a/docs-mkdocs/docs/api/trainer/algorithms/algorithm.md b/docs-mkdocs/docs/api/trainer/algorithms/algorithm.md
@@ -0,0 +1,2 @@
+# opto.trainer.algorithms.algorithm
+::: opto.trainer.algorithms.algorithm
diff --git a/docs-mkdocs/docs/api/trainer/algorithms/basic_algorithms.md b/docs-mkdocs/docs/api/trainer/algorithms/basic_algorithms.md
@@ -0,0 +1,2 @@
+# opto.trainer.algorithms.basic_algorithms
+::: opto.trainer.algorithms.basic_algorithms
diff --git a/docs-mkdocs/docs/api/trainer/algorithms/beamsearch_algorithm.md b/docs-mkdocs/docs/api/trainer/algorithms/beamsearch_algorithm.md
@@ -0,0 +1,2 @@
+# opto.trainer.algorithms.beamsearch_algorithm
+::: opto.trainer.algorithms.beamsearch_algorithm
diff --git a/docs-mkdocs/docs/api/trainer/algorithms/index.md b/docs-mkdocs/docs/api/trainer/algorithms/index.md
@@ -0,0 +1,2 @@
+# opto.trainer.algorithms
+::: opto.trainer.algorithms
diff --git a/docs-mkdocs/docs/api/trainer/evaluators.md b/docs-mkdocs/docs/api/trainer/evaluators.md
@@ -0,0 +1,2 @@
+# opto.trainer.evaluators
+::: opto.trainer.evaluators
diff --git a/docs-mkdocs/docs/api/trainer/guide.md b/docs-mkdocs/docs/api/trainer/guide.md
@@ -0,0 +1,2 @@
+# opto.trainer.guide
+::: opto.trainer.guide
diff --git a/docs-mkdocs/docs/api/trainer/index.md b/docs-mkdocs/docs/api/trainer/index.md
@@ -0,0 +1,2 @@
+# opto.trainer
+::: opto.trainer
diff --git a/docs-mkdocs/docs/api/trainer/loader.md b/docs-mkdocs/docs/api/trainer/loader.md
@@ -0,0 +1,2 @@
+# opto.trainer.loader
+::: opto.trainer.loader
diff --git a/docs-mkdocs/docs/api/trainer/loggers.md b/docs-mkdocs/docs/api/trainer/loggers.md
@@ -0,0 +1,2 @@
+# opto.trainer.loggers
+::: opto.trainer.loggers
diff --git a/docs-mkdocs/docs/api/trainer/suggest.md b/docs-mkdocs/docs/api/trainer/suggest.md
@@ -0,0 +1,2 @@
+# opto.trainer.suggest
+::: opto.trainer.suggest
diff --git a/docs-mkdocs/docs/api/trainer/utils.md b/docs-mkdocs/docs/api/trainer/utils.md
@@ -0,0 +1,2 @@
+# opto.trainer.utils
+::: opto.trainer.utils
diff --git a/docs-mkdocs/docs/api/utils/index.md b/docs-mkdocs/docs/api/utils/index.md
@@ -0,0 +1,2 @@
+# opto.utils
+::: opto.utils
diff --git a/docs-mkdocs/docs/api/utils/llm.md b/docs-mkdocs/docs/api/utils/llm.md
@@ -0,0 +1,2 @@
+# opto.utils.llm
+::: opto.utils.llm
diff --git a/docs-mkdocs/docs/api/version.md b/docs-mkdocs/docs/api/version.md
@@ -0,0 +1,2 @@
+# opto.version
+::: opto.version
diff --git a/docs-mkdocs/mkdocs.yml b/docs-mkdocs/mkdocs.yml
@@ -80,6 +80,9 @@ plugins:
             separate_signature: true
             merge_init_into_class: true
             show_signature_annotations: true
+            show_if_no_docstring: true
+            filters: ["!^_"]
+            ignore_init_summary: true
 
 nav:
   - Get Started: index.md
