Update documentation

MachineLearningLifeScience · Nov 25, 2024 · f336356 · f336356
1 parent 4b6b366
commit f336356
Show file tree

Hide file tree

Showing 493 changed files with 2,484 additions and 2,474 deletions.
diff --git a/_autosummary/poli.core.abstract_benchmark.html b/_autosummary/poli.core.abstract_benchmark.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">

diff --git a/_autosummary/poli.core.abstract_black_box.AbstractBlackBox.html b/_autosummary/poli.core.abstract_black_box.AbstractBlackBox.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>

diff --git a/_autosummary/poli.core.abstract_black_box.NegativeBlackBox.html b/_autosummary/poli.core.abstract_black_box.NegativeBlackBox.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>

diff --git a/_autosummary/poli.core.abstract_black_box.html b/_autosummary/poli.core.abstract_black_box.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">

diff --git a/_autosummary/poli.core.abstract_isolated_function.html b/_autosummary/poli.core.abstract_isolated_function.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">

diff --git a/_autosummary/poli.core.abstract_problem_factory.AbstractProblemFactory.html b/_autosummary/poli.core.abstract_problem_factory.AbstractProblemFactory.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>

diff --git a/_autosummary/poli.core.abstract_problem_factory.MetaProblemFactory.html b/_autosummary/poli.core.abstract_problem_factory.MetaProblemFactory.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1 has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>

diff --git a/_autosummary/poli.core.abstract_problem_factory.html b/_autosummary/poli.core.abstract_problem_factory.html
@@ -185,6 +185,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/optimization_examples/protein-stability-foldx/optimizing_protein_stability.html">Optimizing protein stability using random mutations</a></li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Objective functions</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../using_poli/objective_repository/all_objectives.html">All objective functions</a></li>
@@ -237,11 +242,6 @@
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/bounce.html">Bounce</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../using_poli_baselines/probrep.html">Probabilistic Reparametrization</a></li>
 </ul>
-<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_problem.html">Adding a new black box to the repository</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing/a_new_solver.html">Adding a new optimizer to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code></a></li>
-</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">API reference</span></p>
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API documentation for poli</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">