Skip to content

Commit

Permalink
docs: Build documentation triggered by e96503b
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 31, 2024
1 parent e96503b commit 666e497
Show file tree
Hide file tree
Showing 13 changed files with 111 additions and 111 deletions.
2 changes: 1 addition & 1 deletion docs/latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7f1b053b2be3a71405d22662a0be11cb
config: b0c8626a9d843abb5e7dc96e2abbc94f
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,7 @@ project, such as grid search or cross-validation results.

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

**Total running time of the script:** (0 minutes 6.514 seconds)
**Total running time of the script:** (0 minutes 7.030 seconds)


.. _sphx_glr_download_auto_examples_plot_01_getting_started.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -459,9 +459,9 @@ Numpy array:
.. code-block:: none
array([[ 1.07940211, -0.17079627, 0.32707525],
[ 0.72808672, -0.3453953 , 0.58475624],
[-1.72280206, -0.3701965 , 0.31195055]])
array([[ 1.63853041, -1.28706686, -0.37875963],
[-1.05853815, 2.3366351 , -1.48016548],
[ 0.76746085, -0.03573865, -0.10589976]])
Expand Down Expand Up @@ -513,43 +513,43 @@ Pandas data frame:
<tbody>
<tr>
<th>0</th>
<td>1.927602</td>
<td>-0.743050</td>
<td>-0.019485</td>
<td>-0.432958</td>
<td>-0.806757</td>
<td>-0.095189</td>
<td>-1.373993</td>
<td>0.526623</td>
<td>-1.047739</td>
<td>1.763090</td>
</tr>
<tr>
<th>1</th>
<td>0.763148</td>
<td>1.307049</td>
<td>0.266246</td>
<td>-0.033035</td>
<td>0.358300</td>
<td>0.019338</td>
<td>0.327058</td>
<td>-0.811625</td>
<td>-1.045237</td>
<td>0.229973</td>
</tr>
<tr>
<th>2</th>
<td>0.168696</td>
<td>0.280827</td>
<td>-1.498675</td>
<td>-1.234922</td>
<td>1.775560</td>
<td>-0.885626</td>
<td>0.586916</td>
<td>-0.288776</td>
<td>0.266138</td>
<td>0.793233</td>
</tr>
<tr>
<th>3</th>
<td>1.329606</td>
<td>-1.731826</td>
<td>-0.153971</td>
<td>-0.005179</td>
<td>0.585678</td>
<td>0.656678</td>
<td>1.011807</td>
<td>0.841818</td>
<td>0.976174</td>
<td>1.212396</td>
</tr>
<tr>
<th>4</th>
<td>0.644292</td>
<td>-1.032703</td>
<td>-0.487868</td>
<td>2.313260</td>
<td>-1.211320</td>
<td>-0.733623</td>
<td>-0.071857</td>
<td>-1.319370</td>
<td>0.621754</td>
<td>-0.097709</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -2025,7 +2025,7 @@ Moreover, you can store fitted scikit-learn pipelines:

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

**Total running time of the script:** (0 minutes 1.417 seconds)
**Total running time of the script:** (0 minutes 1.439 seconds)


.. _sphx_glr_download_auto_examples_plot_02_overview_skore_ui.py:
Expand Down

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/latest/auto_examples/plot_01_getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -493,10 +493,10 @@ <h2>Creating a skore project, loading it, and launching the UI<a class="headerli
<p>Now that the project exists, we can write some Python code (in the same
directory) to add (<a class="reference internal" href="../generated/skore.Project.html#skore.Project.put" title="skore.Project.put"><code class="xref py py-func docutils literal notranslate"><span class="pre">put()</span></code></a>) some useful items in it.
Let us load the project and add an integer to it for example:</p>
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">skore</span> <span class="kn">import</span> <span class="n">load</span>
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">skore</span> <span class="kn">import</span> <a href="../generated/skore.load.html#skore.load" title="skore.load" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-function"><span class="n">load</span></a>

<span class="n">my_project</span> <span class="o">=</span> <span class="n">load</span><span class="p">(</span><span class="s2">&quot;my_project.skore&quot;</span><span class="p">)</span>
<span class="n">my_project</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="s2">&quot;my_int&quot;</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
<a href="../generated/skore.Project.html#skore.Project" title="skore.Project" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">my_project</span></a> <span class="o">=</span> <a href="../generated/skore.load.html#skore.load" title="skore.load" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-function"><span class="n">load</span></a><span class="p">(</span><span class="s2">&quot;my_project.skore&quot;</span><span class="p">)</span>
<a href="../generated/skore.Project.html#skore.Project.put" title="skore.Project.put" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-method"><span class="n">my_project</span><span class="o">.</span><span class="n">put</span></a><span class="p">(</span><span class="s2">&quot;my_int&quot;</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -1035,9 +1035,9 @@ <h2>Example of machine learning usage: hyperparameter sweep<a class="headerlink"
</div>
<p>Finally, we store some relevant information to our skore project, so that we
can visualize them later in the skore UI for example:</p>
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="n">my_project</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="s2">&quot;my_gs_cv&quot;</span><span class="p">,</span> <a href="https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.GridSearchCV.html#sklearn.model_selection.GridSearchCV" title="sklearn.model_selection.GridSearchCV" class="sphx-glr-backref-module-sklearn-model_selection sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">gs_cv</span></a><span class="p">)</span>
<span class="n">my_project</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="s2">&quot;my_df&quot;</span><span class="p">,</span> <span class="n">df</span><span class="p">)</span>
<span class="n">my_project</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="s2">&quot;my_fig&quot;</span><span class="p">,</span> <span class="n">fig</span><span class="p">)</span>
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><a href="../generated/skore.Project.html#skore.Project.put" title="skore.Project.put" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-method"><span class="n">my_project</span><span class="o">.</span><span class="n">put</span></a><span class="p">(</span><span class="s2">&quot;my_gs_cv&quot;</span><span class="p">,</span> <a href="https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.GridSearchCV.html#sklearn.model_selection.GridSearchCV" title="sklearn.model_selection.GridSearchCV" class="sphx-glr-backref-module-sklearn-model_selection sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">gs_cv</span></a><span class="p">)</span>
<a href="../generated/skore.Project.html#skore.Project.put" title="skore.Project.put" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-method"><span class="n">my_project</span><span class="o">.</span><span class="n">put</span></a><span class="p">(</span><span class="s2">&quot;my_df&quot;</span><span class="p">,</span> <span class="n">df</span><span class="p">)</span>
<a href="../generated/skore.Project.html#skore.Project.put" title="skore.Project.put" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-method"><span class="n">my_project</span><span class="o">.</span><span class="n">put</span></a><span class="p">(</span><span class="s2">&quot;my_fig&quot;</span><span class="p">,</span> <span class="n">fig</span><span class="p">)</span>
</pre></div>
</div>
</section>
Expand All @@ -1053,11 +1053,11 @@ <h2>Cross-validation with skore<a class="headerlink" href="#cross-validation-wit
let us launch skore’s cross-validation, which will automatically add
(<a class="reference internal" href="../generated/skore.Project.html#skore.Project.put" title="skore.Project.put"><code class="xref py py-func docutils literal notranslate"><span class="pre">put()</span></code></a>)
a <code class="docutils literal notranslate"><span class="pre">cross_validation</span></code> item with a plotly chart in your project.</p>
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">skore</span> <span class="kn">import</span> <span class="n">cross_validate</span>
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">skore</span> <span class="kn">import</span> <a href="../generated/skore.cross_validate.html#skore.cross_validate" title="skore.cross_validate" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-function"><span class="n">cross_validate</span></a>

<span class="n">cv_results</span> <span class="o">=</span> <span class="n">cross_validate</span><span class="p">(</span><a href="https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.Ridge.html#sklearn.linear_model.Ridge" title="sklearn.linear_model.Ridge" class="sphx-glr-backref-module-sklearn-linear_model sphx-glr-backref-type-py-class"><span class="n">Ridge</span></a><span class="p">(),</span> <span class="n">X</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">cv</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">project</span><span class="o">=</span><span class="n">my_project</span><span class="p">)</span>
<span class="n">cv_results</span> <span class="o">=</span> <a href="../generated/skore.cross_validate.html#skore.cross_validate" title="skore.cross_validate" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-function"><span class="n">cross_validate</span></a><span class="p">(</span><a href="https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.Ridge.html#sklearn.linear_model.Ridge" title="sklearn.linear_model.Ridge" class="sphx-glr-backref-module-sklearn-linear_model sphx-glr-backref-type-py-class"><span class="n">Ridge</span></a><span class="p">(),</span> <span class="n">X</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">cv</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">project</span><span class="o">=</span><a href="../generated/skore.Project.html#skore.Project" title="skore.Project" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">my_project</span></a><span class="p">)</span>

<span class="n">fig_plotly</span> <span class="o">=</span> <span class="n">my_project</span><span class="o">.</span><span class="n">get_item</span><span class="p">(</span><span class="s2">&quot;cross_validation&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">plot</span>
<span class="n">fig_plotly</span> <span class="o">=</span> <a href="../generated/skore.Project.html#skore.Project.get_item" title="skore.Project.get_item" class="sphx-glr-backref-module-skore sphx-glr-backref-type-py-method"><span class="n">my_project</span><span class="o">.</span><span class="n">get_item</span></a><span class="p">(</span><span class="s2">&quot;cross_validation&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">plot</span>
</pre></div>
</div>
<div class="admonition note">
Expand Down Expand Up @@ -1090,7 +1090,7 @@ <h2>Manipulating the skore UI<a class="headerlink" href="#manipulating-the-skore
<li><p>In the skore UI on the right, you can drag-and-drop items to re-order them, remove items, etc.</p></li>
</ol>
<img alt="Getting started with ``skore`` demo" src="https://raw.githubusercontent.com/sylvaincom/sylvaincom.github.io/master/files/probabl/skore/2024_10_31_skore_demo_compressed.gif" />
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 6.514 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 7.030 seconds)</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-01-getting-started-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/e97c5b0c37bdd66afd2a201f006613dd/plot_01_getting_started.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">plot_01_getting_started.ipynb</span></code></a></p>
Expand Down
Loading

0 comments on commit 666e497

Please sign in to comment.