Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelgondu committed Nov 21, 2024
1 parent 79df355 commit 4b6b366
Show file tree
Hide file tree
Showing 82 changed files with 5,138 additions and 3,918 deletions.
3 changes: 3 additions & 0 deletions _autosummary/poli.tests.benchmarks.html
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,9 @@ <h1>poli.tests.benchmarks</h1>
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.benchmarks.test_benchmark_creation.html#module-poli.tests.benchmarks.test_benchmark_creation" title="poli.tests.benchmarks.test_benchmark_creation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.benchmarks.test_benchmark_creation</span></code></a></p></td>
<td><p>Test suite for benchmarks.</p></td>
</tr>
</tbody>
</table>
</section>
Expand Down
29 changes: 25 additions & 4 deletions _autosummary/poli.tests.benchmarks.test_benchmark_creation.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -717,8 +715,31 @@ <h1>poli.tests.benchmarks.test_benchmark_creation</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section id="poli-tests-benchmarks-test-benchmark-creation">
<h1>poli.tests.benchmarks.test_benchmark_creation<a class="headerlink" href="#poli-tests-benchmarks-test-benchmark-creation" title="Permalink to this heading">#</a></h1>
<section id="module-poli.tests.benchmarks.test_benchmark_creation">
<span id="poli-tests-benchmarks-test-benchmark-creation"></span><h1>poli.tests.benchmarks.test_benchmark_creation<a class="headerlink" href="#module-poli.tests.benchmarks.test_benchmark_creation" title="Permalink to this heading">#</a></h1>
<p>Test suite for benchmarks.</p>
<p>This test suite only verifies that the benchmarks can
be created without errors. It does not check the correctness
of the benchmarks. In the case of PMO and Guacamol, those
tests are already covered by the tests in objective_repository.</p>
<p class="rubric">Functions</p>
<table class="autosummary longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_creating_embedded_toy_continuous_functions_benchmark</span></code>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_creating_toy_continuous_functions_benchmark</span></code>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_names_from_guacamol_benchmark</span></code>()</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</section>

<script type="text/x-thebe-config">
Expand Down
9 changes: 6 additions & 3 deletions _autosummary/poli.tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -742,13 +742,16 @@ <h1>poli.tests</h1>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.test_core_promises.html#module-poli.tests.test_core_promises" title="poli.tests.test_core_promises"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.test_core_promises</span></code></a></p></td>
<td><p>This test suite contains the core promises we make to the user.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.test_lambda_black_box.html#module-poli.tests.test_lambda_black_box" title="poli.tests.test_lambda_black_box"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.test_lambda_black_box</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.test_data_packages.html#module-poli.tests.test_data_packages" title="poli.tests.test_data_packages"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.test_data_packages</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.test_seeding.html#module-poli.tests.test_seeding" title="poli.tests.test_seeding"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.test_seeding</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.test_lambda_black_box.html#module-poli.tests.test_lambda_black_box" title="poli.tests.test_lambda_black_box"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.test_lambda_black_box</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.test_seeding.html#module-poli.tests.test_seeding" title="poli.tests.test_seeding"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.test_seeding</span></code></a></p></td>
<td><p>This test module tests whether the seeding works in the white noise example.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.util.html#module-poli.tests.util" title="poli.tests.util"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.util</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.util.html#module-poli.tests.util" title="poli.tests.util"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.util</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
Expand Down
3 changes: 3 additions & 0 deletions _autosummary/poli.tests.registry.basic_objectives.html
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,9 @@ <h1>poli.tests.registry.basic_objectives</h1>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.basic_objectives.test_basic_objectives.html#module-poli.tests.registry.basic_objectives.test_basic_objectives" title="poli.tests.registry.basic_objectives.test_basic_objectives"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.basic_objectives.test_basic_objectives</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.registry.basic_objectives.test_budget_exhaustion.html#module-poli.tests.registry.basic_objectives.test_budget_exhaustion" title="poli.tests.registry.basic_objectives.test_budget_exhaustion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.basic_objectives.test_budget_exhaustion</span></code></a></p></td>
<td><p>Tests for the budget exhaustion inside objective functions.</p></td>
</tr>
</tbody>
</table>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -717,8 +715,24 @@ <h1>poli.tests.registry.basic_objectives.test_budget_exhaustion</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section id="poli-tests-registry-basic-objectives-test-budget-exhaustion">
<h1>poli.tests.registry.basic_objectives.test_budget_exhaustion<a class="headerlink" href="#poli-tests-registry-basic-objectives-test-budget-exhaustion" title="Permalink to this heading">#</a></h1>
<section id="module-poli.tests.registry.basic_objectives.test_budget_exhaustion">
<span id="poli-tests-registry-basic-objectives-test-budget-exhaustion"></span><h1>poli.tests.registry.basic_objectives.test_budget_exhaustion<a class="headerlink" href="#module-poli.tests.registry.basic_objectives.test_budget_exhaustion" title="Permalink to this heading">#</a></h1>
<p>Tests for the budget exhaustion inside objective functions.</p>
<p class="rubric">Functions</p>
<table class="autosummary longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_budget_exhausts</span></code>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">test_num_evaluation_tracks_correctly</span></code>()</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</section>

<script type="text/x-thebe-config">
Expand Down
3 changes: 3 additions & 0 deletions _autosummary/poli.tests.registry.chemistry.html
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,9 @@ <h1>poli.tests.registry.chemistry</h1>
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.chemistry.test_chemistry_objectives.html#module-poli.tests.registry.chemistry.test_chemistry_objectives" title="poli.tests.registry.chemistry.test_chemistry_objectives"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.chemistry.test_chemistry_objectives</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -717,8 +715,8 @@ <h1>poli.tests.registry.chemistry.test_chemistry_objectives</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section id="poli-tests-registry-chemistry-test-chemistry-objectives">
<h1>poli.tests.registry.chemistry.test_chemistry_objectives<a class="headerlink" href="#poli-tests-registry-chemistry-test-chemistry-objectives" title="Permalink to this heading">#</a></h1>
<section id="module-poli.tests.registry.chemistry.test_chemistry_objectives">
<span id="poli-tests-registry-chemistry-test-chemistry-objectives"></span><h1>poli.tests.registry.chemistry.test_chemistry_objectives<a class="headerlink" href="#module-poli.tests.registry.chemistry.test_chemistry_objectives" title="Permalink to this heading">#</a></h1>
</section>

<script type="text/x-thebe-config">
Expand Down
7 changes: 5 additions & 2 deletions _autosummary/poli.tests.registry.html
Original file line number Diff line number Diff line change
Expand Up @@ -742,10 +742,13 @@ <h1>poli.tests.registry</h1>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.registry.test_multi_objective_and_negative.html#module-poli.tests.registry.test_multi_objective_and_negative" title="poli.tests.registry.test_multi_objective_and_negative"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.test_multi_objective_and_negative</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.toy_continuous_problems.html#module-poli.tests.registry.toy_continuous_problems" title="poli.tests.registry.toy_continuous_problems"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.toy_continuous_problems</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.test_passing_array_of_strings.html#module-poli.tests.registry.test_passing_array_of_strings" title="poli.tests.registry.test_passing_array_of_strings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.test_passing_array_of_strings</span></code></a></p></td>
<td><p>This module tests whether giving black boxes an array of b strings is equivalent to giving them an array of [b, L] tokens.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.registry.toy_continuous_problems.html#module-poli.tests.registry.toy_continuous_problems" title="poli.tests.registry.toy_continuous_problems"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.toy_continuous_problems</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.registry.toy_discrete_problems.html#module-poli.tests.registry.toy_discrete_problems" title="poli.tests.registry.toy_discrete_problems"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.toy_discrete_problems</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.toy_discrete_problems.html#module-poli.tests.registry.toy_discrete_problems" title="poli.tests.registry.toy_discrete_problems"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.toy_discrete_problems</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
Expand Down
15 changes: 15 additions & 0 deletions _autosummary/poli.tests.registry.proteins.html
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,21 @@ <h1>poli.tests.registry.proteins</h1>
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.proteins.test_foldx.html#module-poli.tests.registry.proteins.test_foldx" title="poli.tests.registry.proteins.test_foldx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.proteins.test_foldx</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.registry.proteins.test_foldx_rfp_lambo.html#module-poli.tests.registry.proteins.test_foldx_rfp_lambo" title="poli.tests.registry.proteins.test_foldx_rfp_lambo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.proteins.test_foldx_rfp_lambo</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.proteins.test_rasp.html#module-poli.tests.registry.proteins.test_rasp" title="poli.tests.registry.proteins.test_rasp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.proteins.test_rasp</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="poli.tests.registry.proteins.test_rmf.html#module-poli.tests.registry.proteins.test_rmf" title="poli.tests.registry.proteins.test_rmf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.proteins.test_rmf</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="poli.tests.registry.proteins.test_rosetta.html#module-poli.tests.registry.proteins.test_rosetta" title="poli.tests.registry.proteins.test_rosetta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poli.tests.registry.proteins.test_rosetta</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</section>
Expand Down
6 changes: 2 additions & 4 deletions _autosummary/poli.tests.registry.proteins.test_foldx.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -717,8 +715,8 @@ <h1>poli.tests.registry.proteins.test_foldx</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section id="poli-tests-registry-proteins-test-foldx">
<h1>poli.tests.registry.proteins.test_foldx<a class="headerlink" href="#poli-tests-registry-proteins-test-foldx" title="Permalink to this heading">#</a></h1>
<section id="module-poli.tests.registry.proteins.test_foldx">
<span id="poli-tests-registry-proteins-test-foldx"></span><h1>poli.tests.registry.proteins.test_foldx<a class="headerlink" href="#module-poli.tests.registry.proteins.test_foldx" title="Permalink to this heading">#</a></h1>
</section>

<script type="text/x-thebe-config">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -717,8 +715,8 @@ <h1>poli.tests.registry.proteins.test_foldx_rfp_lambo</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section id="poli-tests-registry-proteins-test-foldx-rfp-lambo">
<h1>poli.tests.registry.proteins.test_foldx_rfp_lambo<a class="headerlink" href="#poli-tests-registry-proteins-test-foldx-rfp-lambo" title="Permalink to this heading">#</a></h1>
<section id="module-poli.tests.registry.proteins.test_foldx_rfp_lambo">
<span id="poli-tests-registry-proteins-test-foldx-rfp-lambo"></span><h1>poli.tests.registry.proteins.test_foldx_rfp_lambo<a class="headerlink" href="#module-poli.tests.registry.proteins.test_foldx_rfp_lambo" title="Permalink to this heading">#</a></h1>
</section>

<script type="text/x-thebe-config">
Expand Down
6 changes: 2 additions & 4 deletions _autosummary/poli.tests.registry.proteins.test_rasp.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,6 @@





<div class="bd-sidebar-primary bd-sidebar">


Expand Down Expand Up @@ -717,8 +715,8 @@ <h1>poli.tests.registry.proteins.test_rasp</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section id="poli-tests-registry-proteins-test-rasp">
<h1>poli.tests.registry.proteins.test_rasp<a class="headerlink" href="#poli-tests-registry-proteins-test-rasp" title="Permalink to this heading">#</a></h1>
<section id="module-poli.tests.registry.proteins.test_rasp">
<span id="poli-tests-registry-proteins-test-rasp"></span><h1>poli.tests.registry.proteins.test_rasp<a class="headerlink" href="#module-poli.tests.registry.proteins.test_rasp" title="Permalink to this heading">#</a></h1>
</section>

<script type="text/x-thebe-config">
Expand Down
Loading

0 comments on commit 4b6b366

Please sign in to comment.