Skip to content

Commit 95aaa9b

Browse files
author
Circle CI
committed
Update docs for dev (build 4438)
1 parent 76be7bf commit 95aaa9b

29 files changed

Lines changed: 601 additions & 555 deletions
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.

dev/_sources/auto_examples/run_benchopt_prepare.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ We start from the ``minimal_benchmark`` example. Its dataset only defines
9797
<pre class="code-cell-equiv"> <div class='display_example_benchmark'>
9898

9999
<div class='sd-tab-set'>
100-
<input checked="checked" id='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-0' name='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b' type='radio'><label for='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-0'>objective.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseObjective</span>
100+
<input checked="checked" id='example-benchmark-fd000bfa26a04769babb67722257ea7c-0' name='example-benchmark-fd000bfa26a04769babb67722257ea7c' type='radio'><label for='example-benchmark-fd000bfa26a04769babb67722257ea7c-0'>objective.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseObjective</span>
101101
<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
102102

103103

@@ -135,7 +135,7 @@ We start from the ``minimal_benchmark`` example. Its dataset only defines
135135
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="n">X_hat</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
136136
</pre></div>
137137
</div>
138-
<input id='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-1' name='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b' type='radio'><label for='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-1'>datasets/simulated.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseDataset</span>
138+
<input id='example-benchmark-fd000bfa26a04769babb67722257ea7c-1' name='example-benchmark-fd000bfa26a04769babb67722257ea7c' type='radio'><label for='example-benchmark-fd000bfa26a04769babb67722257ea7c-1'>datasets/simulated.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseDataset</span>
139139
<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
140140

141141
<span class="k">class</span><span class="w"> </span><span class="nc">Dataset</span><span class="p">(</span><span class="n">BaseDataset</span><span class="p">):</span>
@@ -150,7 +150,7 @@ We start from the ``minimal_benchmark`` example. Its dataset only defines
150150
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="n">X</span><span class="o">=</span><span class="n">X</span><span class="p">)</span>
151151
</pre></div>
152152
</div>
153-
<input id='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-2' name='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b' type='radio'><label for='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-2'>solvers/gd.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseSolver</span>
153+
<input id='example-benchmark-fd000bfa26a04769babb67722257ea7c-2' name='example-benchmark-fd000bfa26a04769babb67722257ea7c' type='radio'><label for='example-benchmark-fd000bfa26a04769babb67722257ea7c-2'>solvers/gd.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseSolver</span>
154154
<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
155155

156156

@@ -202,7 +202,7 @@ We start from the ``minimal_benchmark`` example. Its dataset only defines
202202
<span class="k">return</span> <span class="p">{</span><span class="s1">&#39;X_hat&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">X_hat</span><span class="p">}</span>
203203
</pre></div>
204204
</div>
205-
<input id='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-3' name='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b' type='radio'><label for='example-benchmark-3e78bb22b3624accaf1d34a342de0a0b-3'>config.yml</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="c1">#loaded from minimal_benchmark/config.yml</span>
205+
<input id='example-benchmark-fd000bfa26a04769babb67722257ea7c-3' name='example-benchmark-fd000bfa26a04769babb67722257ea7c' type='radio'><label for='example-benchmark-fd000bfa26a04769babb67722257ea7c-3'>config.yml</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="c1">#loaded from minimal_benchmark/config.yml</span>
206206
<span class="nt">plot_configs</span><span class="p">:</span>
207207
<span class="w"> </span><span class="nt">Subopt. (log)</span><span class="p">:</span>
208208
<span class="w"> </span><span class="nt">plot_kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">objective_curve</span>
@@ -240,7 +240,7 @@ n_samples=...`` print confirms it runs once for each combination.
240240
.. raw:: html
241241

242242
<div class="output_subarea output_html rendered_html output_result">
243-
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_3tz92re4/prepare_example
243+
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_dbxdg_io/prepare_example
244244
</pre></div>
245245
</pre>
246246

@@ -286,7 +286,7 @@ and skips all preparation work. Each status line now reads
286286
.. raw:: html
287287

288288
<div class="output_subarea output_html rendered_html output_result">
289-
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_3tz92re4/prepare_example
289+
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_dbxdg_io/prepare_example
290290
</pre></div>
291291
</pre>
292292

@@ -370,7 +370,7 @@ and in the right form before ``get_data()`` ever runs.
370370
<pre class="code-cell-equiv"> <div class='display_example_benchmark'>
371371
<p>We now update the following files:</p><br/>
372372
<div class='sd-tab-set'>
373-
<input checked="checked" id='example-benchmark-dc3d49d1a97e4bd58f0a0ebf1726a290-0' name='example-benchmark-dc3d49d1a97e4bd58f0a0ebf1726a290' type='radio'><label for='example-benchmark-dc3d49d1a97e4bd58f0a0ebf1726a290-0'>datasets/simulated.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseDataset</span>
373+
<input checked="checked" id='example-benchmark-6f451b95292e4ac09cff2a0f1164db11-0' name='example-benchmark-6f451b95292e4ac09cff2a0f1164db11' type='radio'><label for='example-benchmark-6f451b95292e4ac09cff2a0f1164db11-0'>datasets/simulated.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseDataset</span>
374374
<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
375375

376376
<span class="k">class</span><span class="w"> </span><span class="nc">Dataset</span><span class="p">(</span><span class="n">BaseDataset</span><span class="p">):</span>
@@ -419,7 +419,7 @@ n_samples=...`` print confirms both combinations are executed.
419419
.. raw:: html
420420

421421
<div class="output_subarea output_html rendered_html output_result">
422-
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_3tz92re4/prepare_example
422+
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_dbxdg_io/prepare_example
423423
</pre></div>
424424
</pre>
425425

@@ -502,7 +502,7 @@ parameter combinations that differ only in ignored dimensions and runs
502502
<pre class="code-cell-equiv"> <div class='display_example_benchmark'>
503503
<p>We now update the following files:</p><br/>
504504
<div class='sd-tab-set'>
505-
<input checked="checked" id='example-benchmark-0df7e0524e0846cb8a475cfc794065fb-0' name='example-benchmark-0df7e0524e0846cb8a475cfc794065fb' type='radio'><label for='example-benchmark-0df7e0524e0846cb8a475cfc794065fb-0'>datasets/simulated.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseDataset</span>
505+
<input checked="checked" id='example-benchmark-191b3bff890b43a89c611624a923d5d5-0' name='example-benchmark-191b3bff890b43a89c611624a923d5d5' type='radio'><label for='example-benchmark-191b3bff890b43a89c611624a923d5d5-0'>datasets/simulated.py</label><div class='sd-tab-content'><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">benchopt</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseDataset</span>
506506
<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
507507

508508
<span class="k">class</span><span class="w"> </span><span class="nc">Dataset</span><span class="p">(</span><span class="n">BaseDataset</span><span class="p">):</span>
@@ -551,7 +551,7 @@ prints exactly twice.
551551
.. raw:: html
552552

553553
<div class="output_subarea output_html rendered_html output_result">
554-
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_3tz92re4/prepare_example
554+
<pre class="code-cell-equiv"><div class="highlight"><pre><span></span><span class="gp">$ </span>benchopt<span class="w"> </span>prepare<span class="w"> </span>temp_benchmark_dbxdg_io/prepare_example
555555
</pre></div>
556556
</pre>
557557

@@ -586,7 +586,7 @@ per-parameter processing at all.
586586

587587
.. rst-class:: sphx-glr-timing
588588

589-
**Total running time of the script:** (0 minutes 0.036 seconds)
589+
**Total running time of the script:** (0 minutes 0.042 seconds)
590590

591591

592592
.. _sphx_glr_download_auto_examples_run_benchopt_prepare.py:

0 commit comments

Comments
 (0)