[ci skip] DOC add mention of pre-commit a784506

scikit-learn-contrib · May 18, 2024 · 09565f0 · 09565f0
1 parent 5a5f558
commit 09565f0
Show file tree

Hide file tree

Showing 28 changed files with 128 additions and 91 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f4ed13ed34cc7b1f69ceaf744249b8b8
+config: 0ce5cfc3128298ad3a1c530d86a4235a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/_sources/auto_examples/plot_classifier.rst.txt b/_sources/auto_examples/plot_classifier.rst.txt
@@ -110,7 +110,7 @@ Use scikit-learn to display the decision boundary
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.136 seconds)
+   **Total running time of the script:** (0 minutes 0.137 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_classifier.py:

diff --git a/_sources/auto_examples/plot_transformer.rst.txt b/_sources/auto_examples/plot_transformer.rst.txt
@@ -63,7 +63,7 @@ An example plot of :class:`skltemplate.template.TemplateTransformer`
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.063 seconds)
+   **Total running time of the script:** (0 minutes 0.061 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_transformer.py:

diff --git a/_sources/auto_examples/sg_execution_times.rst.txt b/_sources/auto_examples/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.275** total execution time for 3 files **from auto_examples**:
+**00:00.273** total execution time for 3 files **from auto_examples**:
 
 .. container::
 
@@ -33,11 +33,11 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_auto_examples_plot_classifier.py` (``plot_classifier.py``)
-     - 00:00.136
+     - 00:00.137
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_template.py` (``plot_template.py``)
      - 00:00.075
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_transformer.py` (``plot_transformer.py``)
-     - 00:00.063
+     - 00:00.061
      - 0.0
diff --git a/_sources/quick_start.rst.txt b/_sources/quick_start.rst.txt
@@ -134,6 +134,30 @@ In addition, you have a linter task to check the code consistency in terms of st
 
   pixi run lint
 
+Activating the development environment
+--------------------------------------
+
+In the case that you don't want to use the `pixi run` commands and directly interact
+with the usual python tools, you can activate the development environment:
+
+.. prompt:: bash $
+
+  pixi shell -e dev
+
+This will activate an environment containing the dependencies needed to run the linters,
+tests, and build the documentation. So for instance, you can run the tests with:
+
+.. prompt:: bash $
+
+  pytest -vsl skltemplate
+
+In this case, you can even use pre-commit before using git. You will need to initialize
+it with:
+
+.. prompt:: bash $
+
+  pre-commit install
+
 Setup the continuous integration
 --------------------------------
 

diff --git a/_sources/sg_execution_times.rst.txt b/_sources/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.275** total execution time for 3 files **from all galleries**:
+**00:00.273** total execution time for 3 files **from all galleries**:
 
 .. container::
 
@@ -33,11 +33,11 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_auto_examples_plot_classifier.py` (``../examples/plot_classifier.py``)
-     - 00:00.136
+     - 00:00.137
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_template.py` (``../examples/plot_template.py``)
      - 00:00.075
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_transformer.py` (``../examples/plot_transformer.py``)
-     - 00:00.063
+     - 00:00.061
      - 0.0
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.2.dev1+g939dd4e',
+    VERSION: '0.1.2.dev3+ga784506',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api.html b/api.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>API Reference &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>API Reference &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="_static/documentation_options.js?v=4262caba"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=36754332"></script>
@@ -127,8 +127,8 @@
 
 
 
-    <img src="_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>

diff --git a/auto_examples/index.html b/auto_examples/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Example Gallery &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>Example Gallery &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="../_static/documentation_options.js?v=4262caba"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -127,8 +127,8 @@
 
 
 
-    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>

diff --git a/auto_examples/plot_classifier.html b/auto_examples/plot_classifier.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Plotting Template Classifier &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>Plotting Template Classifier &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="../_static/documentation_options.js?v=4262caba"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -126,8 +126,8 @@
 
 
 
-    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>
@@ -446,7 +446,7 @@
 <img src="../_images/sphx_glr_plot_classifier_001.png" srcset="../_images/sphx_glr_plot_classifier_001.png" alt="Template Classifier Decision Boundary" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[Text(0.5, 23.52222222222222, &#39;Feature 1&#39;), Text(30.972222222222214, 0.5, &#39;Feature 2&#39;), Text(0.5, 1.0, &#39;Template Classifier Decision Boundary&#39;)]
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.136 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.137 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-classifier-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/fed3e85cac62fc93e088aa8cb008d467/plot_classifier.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_classifier.ipynb</span></code></a></p>

diff --git a/auto_examples/plot_template.html b/auto_examples/plot_template.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Plotting Template Estimator &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>Plotting Template Estimator &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="../_static/documentation_options.js?v=4262caba"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -127,8 +127,8 @@
 
 
 
-    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>

diff --git a/auto_examples/plot_transformer.html b/auto_examples/plot_transformer.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Plotting Template Transformer &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>Plotting Template Transformer &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="../_static/documentation_options.js?v=4262caba"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -127,8 +127,8 @@
 
 
 
-    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>
@@ -432,7 +432,7 @@
 <a href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.063 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 0.061 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-transformer-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/5b2cebfab9d8cca4393d66b1e4b8a8e7/plot_transformer.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_transformer.ipynb</span></code></a></p>

diff --git a/auto_examples/sg_execution_times.html b/auto_examples/sg_execution_times.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Computation times &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>Computation times &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="../_static/documentation_options.js?v=4262caba"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -125,8 +125,8 @@
 
 
 
-    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>
@@ -387,7 +387,7 @@
 
   <section id="computation-times">
 <span id="sphx-glr-auto-examples-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">#</a></h1>
-<p><strong>00:00.275</strong> total execution time for 3 files <strong>from auto_examples</strong>:</p>
+<p><strong>00:00.273</strong> total execution time for 3 files <strong>from auto_examples</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" />
@@ -409,15 +409,15 @@
 </thead>
 <tbody>
 <tr class="row-even"><td><p><a class="reference internal" href="plot_classifier.html#sphx-glr-auto-examples-plot-classifier-py"><span class="std std-ref">Plotting Template Classifier</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_classifier.py</span></code>)</p></td>
-<td><p>00:00.136</p></td>
+<td><p>00:00.137</p></td>
 <td><p>0.0</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_template.html#sphx-glr-auto-examples-plot-template-py"><span class="std std-ref">Plotting Template Estimator</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_template.py</span></code>)</p></td>
 <td><p>00:00.075</p></td>
 <td><p>0.0</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="plot_transformer.html#sphx-glr-auto-examples-plot-transformer-py"><span class="std std-ref">Plotting Template Transformer</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_transformer.py</span></code>)</p></td>
-<td><p>00:00.063</p></td>
+<td><p>00:00.061</p></td>
 <td><p>0.0</p></td>
 </tr>
 </tbody>

diff --git a/generated/skltemplate.TemplateClassifier.html b/generated/skltemplate.TemplateClassifier.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>TemplateClassifier &#8212; Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation</title>
+    <title>TemplateClassifier &#8212; Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation</title>
 
 
 
@@ -42,7 +42,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
 
-    <script src="../_static/documentation_options.js?v=8d1d479a"></script>
+    <script src="../_static/documentation_options.js?v=4262caba"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -127,8 +127,8 @@
 
 
 
-    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>
-    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev1+g939dd4e documentation - Home"/>`);</script>
+    <img src="../_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>
+    <script>document.write(`<img src="../_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.1.2.dev3+ga784506 documentation - Home"/>`);</script>
 
 
 </a></div>