Merge branch 'main' into documentation-on-s3

probabl-ai · Dec 2, 2024 · 014b3a0 · 014b3a0
2 parents a111752 + 7504c96
commit 014b3a0
Show file tree

Hide file tree

Showing 77 changed files with 2,806 additions and 740 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -83,7 +83,7 @@ jobs:
 
       - name: Post to slack
         continue-on-error: true
-        uses: slackapi/slack-github-action@v1.27.0
+        uses: slackapi/slack-github-action@v2.0.0
         with:
           channel-id: "product-releases"
           payload: |

diff --git a/.github/workflows/skore.yml b/.github/workflows/skore.yml
@@ -41,8 +41,9 @@ jobs:
           # Test
           python -m pytest --no-cov src/ tests/
 
-  skore-coverage:
+  coverage-skore:
     runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5

diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo
@@ -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: 8f2404146afc07a39073cf8cdd0d4eaa
+config: 3f392d251f0197d80d871686fdc9d144
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/...45032a868744b/plot_05_train_test_split.py → ...9d9272c9a8cdb/plot_02_train_test_split.py b/...45032a868744b/plot_05_train_test_split.py → ...9d9272c9a8cdb/plot_02_train_test_split.py
diff --git a/docs/latest/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/docs/latest/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/...b57261e52107/plot_03_cross_validate.ipynb → ...27849f5a423b/plot_01_cross_validate.ipynb b/...b57261e52107/plot_03_cross_validate.ipynb → ...27849f5a423b/plot_01_cross_validate.ipynb
diff --git a/...50d2a0f66cc5fb1/plot_03_cross_validate.py → ...5030c696b8fe135/plot_01_cross_validate.py b/...50d2a0f66cc5fb1/plot_03_cross_validate.py → ...5030c696b8fe135/plot_01_cross_validate.py
diff --git a/...01f006613dd/plot_01_getting_started.ipynb → ...bd8834fb5d8/plot_01_getting_started.ipynb b/...01f006613dd/plot_01_getting_started.ipynb → ...bd8834fb5d8/plot_01_getting_started.ipynb
diff --git a/...657c932abde8d0d/plot_04_tracking_items.py → ...19e3672ab30e7b3/plot_02_tracking_items.py b/...657c932abde8d0d/plot_04_tracking_items.py → ...19e3672ab30e7b3/plot_02_tracking_items.py
diff --git a/...66ced5b7bc6a6d/plot_03_cross_validate.zip → ...127bb963835935/plot_01_cross_validate.zip b/...66ced5b7bc6a6d/plot_03_cross_validate.zip → ...127bb963835935/plot_01_cross_validate.zip
diff --git a/docs/latest/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/docs/latest/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/...486b997717/plot_05_train_test_split.ipynb → ...208c08288b/plot_02_train_test_split.ipynb b/...486b997717/plot_05_train_test_split.ipynb → ...208c08288b/plot_02_train_test_split.ipynb
diff --git a/...e8450bd29651e5/plot_01_getting_started.py → ...9bfb2f5f6870e0/plot_01_getting_started.py b/...e8450bd29651e5/plot_01_getting_started.py → ...9bfb2f5f6870e0/plot_01_getting_started.py
diff --git a/...aaa53a/plot_02_overview_skore_project.zip → ...6ea016/plot_01_overview_skore_project.zip b/...aaa53a/plot_02_overview_skore_project.zip → ...6ea016/plot_01_overview_skore_project.zip
diff --git a/...d8a4588515de/plot_05_train_test_split.zip → ...6f41dc43832c/plot_02_train_test_split.zip b/...d8a4588515de/plot_05_train_test_split.zip → ...6f41dc43832c/plot_02_train_test_split.zip
diff --git a/...269d4d66baefe0/plot_04_tracking_items.zip → ...7fe85f16458c1e/plot_02_tracking_items.zip b/...269d4d66baefe0/plot_04_tracking_items.zip → ...7fe85f16458c1e/plot_02_tracking_items.zip
diff --git a/...5f80dd1da442/plot_04_tracking_items.ipynb → ...84c4a66b9486/plot_02_tracking_items.ipynb b/...5f80dd1da442/plot_04_tracking_items.ipynb → ...84c4a66b9486/plot_02_tracking_items.ipynb
diff --git a/...e5dad81/plot_02_overview_skore_project.py → ...24ae7af/plot_01_overview_skore_project.py b/...e5dad81/plot_02_overview_skore_project.py → ...24ae7af/plot_01_overview_skore_project.py
diff --git a/...128e/plot_02_overview_skore_project.ipynb → ...bd7d/plot_01_overview_skore_project.ipynb b/...128e/plot_02_overview_skore_project.ipynb → ...bd7d/plot_01_overview_skore_project.ipynb
diff --git a/...cbe5e4682d2a1/plot_01_getting_started.zip → ...aa974f7c36c1d/plot_01_getting_started.zip b/...cbe5e4682d2a1/plot_01_getting_started.zip → ...aa974f7c36c1d/plot_01_getting_started.zip
diff --git a/...sphx_glr_plot_03_cross_validate_thumb.png → ...sphx_glr_plot_01_cross_validate_thumb.png b/...sphx_glr_plot_03_cross_validate_thumb.png → ...sphx_glr_plot_01_cross_validate_thumb.png
diff --git a/docs/latest/_images/sphx_glr_plot_01_getting_started_001.png b/docs/latest/_images/sphx_glr_plot_01_getting_started_001.png
diff --git a/...lr_plot_02_overview_skore_project_001.png → ...lr_plot_01_overview_skore_project_001.png b/...lr_plot_02_overview_skore_project_001.png → ...lr_plot_01_overview_skore_project_001.png
diff --git a/..._plot_02_overview_skore_project_thumb.png → ..._plot_01_overview_skore_project_thumb.png b/..._plot_02_overview_skore_project_thumb.png → ..._plot_01_overview_skore_project_thumb.png
diff --git a/...sphx_glr_plot_04_tracking_items_thumb.png → ...sphx_glr_plot_02_tracking_items_thumb.png b/...sphx_glr_plot_04_tracking_items_thumb.png → ...sphx_glr_plot_02_tracking_items_thumb.png
diff --git a/...hx_glr_plot_05_train_test_split_thumb.png → ...hx_glr_plot_02_train_test_split_thumb.png b/...hx_glr_plot_05_train_test_split_thumb.png → ...hx_glr_plot_02_train_test_split_thumb.png
diff --git a/docs/latest/_sources/api.rst.txt b/docs/latest/_sources/api.rst.txt
@@ -5,6 +5,10 @@ API
 
 This page lists all the public functions and classes of the skore package.
 
+.. warning ::
+
+    This code is still in development. **The API is subject to change.**
+
 Project
 -------
 

diff --git a/docs/latest/_sources/auto_examples/00_getting_started/index.rst.txt b/docs/latest/_sources/auto_examples/00_getting_started/index.rst.txt
@@ -0,0 +1,47 @@
+
+
+.. _sphx_glr_auto_examples_00_getting_started:
+
+Getting started
+---------------
+
+We recommend first having a look at this example that serves as an overall and gentle
+introduction to skore.
+
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+.. thumbnail-parent-div-open
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="Getting started with skore">
+
+.. only:: html
+
+  .. image:: /auto_examples/00_getting_started/images/thumb/sphx_glr_plot_01_getting_started_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_auto_examples_00_getting_started_plot_01_getting_started.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Getting started with skore</div>
+    </div>
+
+
+.. thumbnail-parent-div-close
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /auto_examples/00_getting_started/plot_01_getting_started
+
diff --git a/..._examples/plot_01_getting_started.rst.txt → ...g_started/plot_01_getting_started.rst.txt b/..._examples/plot_01_getting_started.rst.txt → ...g_started/plot_01_getting_started.rst.txt
diff --git a/docs/latest/_sources/auto_examples/01_track/index.rst.txt b/docs/latest/_sources/auto_examples/01_track/index.rst.txt
@@ -0,0 +1,64 @@
+
+
+.. _sphx_glr_auto_examples_01_track:
+
+Track
+-----
+
+These examples illustrate the skore Project and UI.
+
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+.. thumbnail-parent-div-open
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="This example provides an overview of the functionalities and the different types of items that we can store in a skore Project.">
+
+.. only:: html
+
+  .. image:: /auto_examples/01_track/images/thumb/sphx_glr_plot_01_overview_skore_project_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_auto_examples_01_track_plot_01_overview_skore_project.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Overview of the skore project</div>
+    </div>
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates how skore can be used to track some items using their history, for example tracking some ML metrics over time.">
+
+.. only:: html
+
+  .. image:: /auto_examples/01_track/images/thumb/sphx_glr_plot_02_tracking_items_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_auto_examples_01_track_plot_02_tracking_items.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Tracking items using their history</div>
+    </div>
+
+
+.. thumbnail-parent-div-close
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /auto_examples/01_track/plot_01_overview_skore_project
+   /auto_examples/01_track/plot_02_tracking_items
+
diff --git a/...es/plot_02_overview_skore_project.rst.txt → ...ck/plot_01_overview_skore_project.rst.txt b/...es/plot_02_overview_skore_project.rst.txt → ...ck/plot_01_overview_skore_project.rst.txt
diff --git a/...o_examples/plot_04_tracking_items.rst.txt → ...s/01_track/plot_02_tracking_items.rst.txt b/...o_examples/plot_04_tracking_items.rst.txt → ...s/01_track/plot_02_tracking_items.rst.txt
diff --git a/docs/latest/_sources/auto_examples/02_diagnose/index.rst.txt b/docs/latest/_sources/auto_examples/02_diagnose/index.rst.txt
@@ -0,0 +1,65 @@
+
+
+.. _sphx_glr_auto_examples_02_diagnose:
+
+Diagnose
+--------
+
+These examples illustrate how skore can help data scientists to improve their
+machine learning modelling thanks to diagnostics.
+
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+.. thumbnail-parent-div-open
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the motivation and the use of skore&#x27;s skore.cross_validate to get assistance when developing ML/DS projects.">
+
+.. only:: html
+
+  .. image:: /auto_examples/02_diagnose/images/thumb/sphx_glr_plot_01_cross_validate_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_auto_examples_02_diagnose_plot_01_cross_validate.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Enhancing cross-validation</div>
+    </div>
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the motivation and the use of skore&#x27;s skore.train_test_split to get assistance when developing ML/DS projects.">
+
+.. only:: html
+
+  .. image:: /auto_examples/02_diagnose/images/thumb/sphx_glr_plot_02_train_test_split_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_auto_examples_02_diagnose_plot_02_train_test_split.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Enhancing train-test split</div>
+    </div>
+
+
+.. thumbnail-parent-div-close
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /auto_examples/02_diagnose/plot_01_cross_validate
+   /auto_examples/02_diagnose/plot_02_train_test_split
+
diff --git a/...o_examples/plot_03_cross_validate.rst.txt → ...2_diagnose/plot_01_cross_validate.rst.txt b/...o_examples/plot_03_cross_validate.rst.txt → ...2_diagnose/plot_01_cross_validate.rst.txt
diff --git a/...examples/plot_05_train_test_split.rst.txt → ...diagnose/plot_02_train_test_split.rst.txt b/...examples/plot_05_train_test_split.rst.txt → ...diagnose/plot_02_train_test_split.rst.txt
@@ -2,20 +2,20 @@
 .. DO NOT EDIT.
 .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
 .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
-.. "auto_examples/plot_05_train_test_split.py"
+.. "auto_examples/02_diagnose/plot_02_train_test_split.py"
 .. LINE NUMBERS ARE GIVEN BELOW.
 
 .. only:: html
 
     .. note::
         :class: sphx-glr-download-link-note
 
-        :ref:`Go to the end <sphx_glr_download_auto_examples_plot_05_train_test_split.py>`
+        :ref:`Go to the end <sphx_glr_download_auto_examples_02_diagnose_plot_02_train_test_split.py>`
         to download the full example code.
 
 .. rst-class:: sphx-glr-example-title
 
-.. _sphx_glr_auto_examples_plot_05_train_test_split.py:
+.. _sphx_glr_auto_examples_02_diagnose_plot_02_train_test_split.py:
 
 
 .. _example_train_test_split:
@@ -74,12 +74,12 @@ We create and load the skore project from this temporary directory:
 
  .. code-block:: none
 
-                        <Logger skore.project.project (INFO)> Project  create.py:148
+    [12/02/24 07:55:38] <Logger skore.project.project (INFO)> Project  create.py:148
                                                               file                  
                                                               '/tmp/sk              
                                                               ore_exam              
-                                                              ple_3nw2              
-                                                              z46d/my_              
+                                                              ple_t1iz              
+                                                              n79h/my_              
                                                               project.              
                                                               skore'                
                                                               was                   
@@ -584,26 +584,26 @@ Removing the temporary directory:
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.046 seconds)
+   **Total running time of the script:** (0 minutes 0.043 seconds)
 
 
-.. _sphx_glr_download_auto_examples_plot_05_train_test_split.py:
+.. _sphx_glr_download_auto_examples_02_diagnose_plot_02_train_test_split.py:
 
 .. only:: html
 
   .. container:: sphx-glr-footer sphx-glr-footer-example
 
     .. container:: sphx-glr-download sphx-glr-download-jupyter
 
-      :download:`Download Jupyter notebook: plot_05_train_test_split.ipynb <plot_05_train_test_split.ipynb>`
+      :download:`Download Jupyter notebook: plot_02_train_test_split.ipynb <plot_02_train_test_split.ipynb>`
 
     .. container:: sphx-glr-download sphx-glr-download-python
 
-      :download:`Download Python source code: plot_05_train_test_split.py <plot_05_train_test_split.py>`
+      :download:`Download Python source code: plot_02_train_test_split.py <plot_02_train_test_split.py>`
 
     .. container:: sphx-glr-download sphx-glr-download-zip
 
-      :download:`Download zipped: plot_05_train_test_split.zip <plot_05_train_test_split.zip>`
+      :download:`Download zipped: plot_02_train_test_split.zip <plot_02_train_test_split.zip>`
 
 
 .. only:: html
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,10 @@ API @@
     This page lists all the public functions and classes of the skore package.
+    .. warning ::
+        This code is still in development. **The API is subject to change.**
     Project
     -------
@@ Expand Down @@