New argument return_array_descriptor in run_benchmark

Author: gabrielfougeron

docs/gh-pages/_build/auto_examples/benchmarks/Benchmark_Hardware_Info.html

@@ -75,7 +75,7 @@
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="Description of the benchmark machine" href="Benchmark_Hardware_Info.html" />
-    <link rel="prev" title="Time Trains" href="../tutorial/10-TimeTrains.html" />
+    <link rel="prev" title="Running benchmarks manually" href="../tutorial/11-Manual_benchmarks.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   <meta name="docsearch:version" content="main" />
@@ -414,6 +414,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../tutorial/08-Lengthy_benchmarks.html">Time-consuming benchmarks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../tutorial/09-Vector_output.html">Vector outputs</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../tutorial/10-TimeTrains.html">Time Trains</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../tutorial/11-Manual_benchmarks.html">Running benchmarks manually</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Benchmarks</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>

docs/gh-pages/_build/auto_examples/benchmarks/Hashing.html

@@ -454,7 +454,7 @@
 
   <section id="computation-times">
 <span id="sphx-glr-build-auto-examples-benchmarks-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">#</a></h1>
-<p><strong>00:01.102</strong> total execution time for 4 files <strong>from _build/auto_examples/benchmarks</strong>:</p>
+<p><strong>00:01.211</strong> total execution time for 4 files <strong>from _build/auto_examples/benchmarks</strong>:</p>
 <div class="docutils container">
 <style scoped>
 <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
@@ -476,19 +476,19 @@
 </thead>
 <tbody>
 <tr class="row-even"><td><p><a class="reference internal" href="Inplace_conjugate.html#sphx-glr-build-auto-examples-benchmarks-inplace-conjugate-py"><span class="std std-ref">Benchmark of inplace conjugation of arrays</span></a> (<code class="docutils literal notranslate"><span class="pre">Inplace_conjugate.py</span></code>)</p></td>
-<td><p>00:00.548</p></td>
+<td><p>00:00.616</p></td>
 <td><p>0.0</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="Hashing.html#sphx-glr-build-auto-examples-benchmarks-hashing-py"><span class="std std-ref">Time benchmark of built-in hashing in Python</span></a> (<code class="docutils literal notranslate"><span class="pre">Hashing.py</span></code>)</p></td>
-<td><p>00:00.345</p></td>
+<td><p>00:00.379</p></td>
 <td><p>0.0</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="numpy_array_init.html#sphx-glr-build-auto-examples-benchmarks-numpy-array-init-py"><span class="std std-ref">Numpy array initialization</span></a> (<code class="docutils literal notranslate"><span class="pre">numpy_array_init.py</span></code>)</p></td>
-<td><p>00:00.130</p></td>
+<td><p>00:00.139</p></td>
 <td><p>0.0</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="Benchmark_Hardware_Info.html#sphx-glr-build-auto-examples-benchmarks-benchmark-hardware-info-py"><span class="std std-ref">Description of the benchmark machine</span></a> (<code class="docutils literal notranslate"><span class="pre">Benchmark_Hardware_Info.py</span></code>)</p></td>
-<td><p>00:00.079</p></td>
+<td><p>00:00.077</p></td>
 <td><p>0.0</p></td>
 </tr>
 </tbody>

docs/gh-pages/_build/auto_examples/benchmarks/Inplace_conjugate.html

@@ -414,6 +414,7 @@
 <li class="toctree-l2"><a class="reference internal" href="tutorial/08-Lengthy_benchmarks.html">Time-consuming benchmarks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial/09-Vector_output.html">Vector outputs</a></li>
 <li class="toctree-l2"><a class="reference internal" href="tutorial/10-TimeTrains.html">Time Trains</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/11-Manual_benchmarks.html">Running benchmarks manually</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="benchmarks/index.html">Benchmarks</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
@@ -522,6 +523,9 @@ <h2>Tutorial<a class="headerlink" href="#tutorial" title="Link to this heading">
 </div><div class="sphx-glr-thumbcontainer" tooltip="Time Trains"><img alt="" src="../../_images/sphx_glr_10-TimeTrains_thumb.png" />
 <p><a class="reference internal" href="tutorial/10-TimeTrains.html#sphx-glr-build-auto-examples-tutorial-10-timetrains-py"><span class="std std-ref">Time Trains</span></a></p>
   <div class="sphx-glr-thumbnail-title">Time Trains</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="Running benchmarks manually"><img alt="" src="../../_images/sphx_glr_11-Manual_benchmarks_thumb.png" />
+<p><a class="reference internal" href="tutorial/11-Manual_benchmarks.html#sphx-glr-build-auto-examples-tutorial-11-manual-benchmarks-py"><span class="std std-ref">Running benchmarks manually</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Running benchmarks manually</div>
 </div></div></section>
 <section id="benchmarks">
 <h2>Benchmarks<a class="headerlink" href="#benchmarks" title="Link to this heading">#</a></h2>

docs/gh-pages/_build/auto_examples/benchmarks/index.html

@@ -414,6 +414,7 @@
 <li class="toctree-l2"><a class="reference internal" href="08-Lengthy_benchmarks.html">Time-consuming benchmarks</a></li>
 <li class="toctree-l2"><a class="reference internal" href="09-Vector_output.html">Vector outputs</a></li>
 <li class="toctree-l2"><a class="reference internal" href="10-TimeTrains.html">Time Trains</a></li>
+<li class="toctree-l2"><a class="reference internal" href="11-Manual_benchmarks.html">Running benchmarks manually</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../benchmarks/index.html">Benchmarks</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
@@ -509,29 +510,42 @@
     <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
         <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
-<a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_funs</span></a></a></a></a> <span class="o">=</span> <span class="p">[</span>
+<a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_funs</span></a> <span class="o">=</span> <span class="p">[</span>
     <span class="n">comprehension</span>   <span class="p">,</span>
     <span class="n">star_operator</span>   <span class="p">,</span>
     <span class="n">for_loop_append</span> <span class="p">,</span>
 <span class="p">]</span>
 </pre></div>
 </div>
 <p>Let’s define relevant sizes of lists to be timed.</p>
-<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">n_bench</span></a></a></a></a> <span class="o">=</span> <span class="mi">12</span>
-<a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_sizes</span></a></a></a></a> <span class="o">=</span> <span class="p">[</span><span class="mi">2</span><span class="o">**</span><span class="n">n</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">n_bench</span></a></a></a></a><span class="p">)]</span>
+<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">n_bench</span></a> <span class="o">=</span> <span class="mi">12</span>
+<a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_sizes</span></a> <span class="o">=</span> <span class="p">[</span><span class="mi">2</span><span class="o">**</span><span class="n">n</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">n_bench</span></a><span class="p">)]</span>
 </pre></div>
 </div>
 <p>Now, let’s import pyquickbench, run and plot the benchmark</p>
 <div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">pyquickbench</span>
 
 <span class="n">pyquickbench</span><span class="o">.</span><span class="n">run_benchmark</span><span class="p">(</span>
-    <a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_sizes</span></a></a></a></a>   <span class="p">,</span>
-    <a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_funs</span></a></a></a></a>    <span class="p">,</span>
+    <a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_sizes</span></a>   <span class="p">,</span>
+    <a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_funs</span></a>    <span class="p">,</span>
     <span class="n">show</span> <span class="o">=</span> <span class="kc">True</span> <span class="p">,</span>
 <span class="p">)</span>
 </pre></div>
 </div>
 <img src="../../../_images/sphx_glr_01-First_benchmark_001.png" srcset="../../../_images/sphx_glr_01-First_benchmark_001.png" alt="01 First benchmark" class = "sphx-glr-single-img"/><p>From this benchmark, it is easy to see that initializing a list to a given length filled with a single value is quickest using the star operator.</p>
+<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">res</span></a> <span class="o">=</span> <span class="n">pyquickbench</span><span class="o">.</span><span class="n">run_benchmark</span><span class="p">(</span>
+    <a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_sizes</span></a>   <span class="p">,</span>
+    <a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">all_funs</span></a>    <span class="p">,</span>
+<span class="p">)</span>
+
+<span class="nb">print</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">res</span></a><span class="p">))</span>
+<span class="nb">print</span><span class="p">(</span><a href="https://docs.python.org/3/library/stdtypes.html#tuple" title="builtins.tuple" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">res</span><span class="o">.</span><span class="n">shape</span></a><span class="p">)</span>
+</pre></div>
+</div>
+<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>&lt;class &#39;numpy.ndarray&#39;&gt;
+(12, 3, 1, 1)
+</pre></div>
+</div>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-build-auto-examples-tutorial-01-first-benchmark-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../../../_downloads/a97bdd5149b0f6baa3efc4e0f298d86f/01-First_benchmark.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">01-First_benchmark.ipynb</span></code></a></p>