Merge branch 'main' into fix-ci-on-fork

# Conflicts: # .github/workflows/skore.yml
probabl-ai · Jan 9, 2025 · 35857f3 · 35857f3
2 parents d532328 + 24a7c1b
commit 35857f3
Show file tree

Hide file tree

Showing 55 changed files with 1,243 additions and 647 deletions.
diff --git a/.github/workflows/backend.yml b/.github/workflows/backend.yml
@@ -45,13 +45,21 @@ jobs:
 
   backend-test:
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         os: ["ubuntu-latest", "windows-latest"]
         python: ["3.9", "3.10", "3.11", "3.12"]
+        scikit-learn: ["1.6"]
         include:
           - os: "ubuntu-latest"
             python: "3.12"
+            scikit-learn: "1.4"
+          - os: "ubuntu-latest"
+            python: "3.12"
+            scikit-learn: "1.5"
+          - os: "ubuntu-latest"
+            python: "3.12"
+            scikit-learn: "1.6"
             coverage: true
     runs-on: ${{ matrix.os }}
     steps:
@@ -64,16 +72,60 @@ jobs:
           python-version: ${{ matrix.python }}
           cache: pip
 
-      - name: Install dependencies
-        run: python -m pip install --upgrade pip build
+      - name: Restore python-venv
+        uses: actions/cache/restore@v4
+        id: cache-python-venv
+        with:
+          path: 'skore/venv'
+          key: python-venv-${{ matrix.os }}-${{ matrix.python }}-${{ matrix.scikit-learn }}-${{ hashFiles('skore/pyproject.toml') }}
+
+      - name: Setup python-venv
+        working-directory: "skore/"
+        run: |
+          set -eu
+
+          # Ensure venv is created
+          python -m venv venv
+
+          # Activate venv for each step depending on the OS
+          if [[ "${{ matrix.os }}" == "ubuntu-latest" ]]; then
+              echo "${GITHUB_WORKSPACE}/skore/venv/bin" >> ${GITHUB_PATH}
+              echo "VIRTUAL_ENV=${GITHUB_WORKSPACE}/skore/venv" >> ${GITHUB_ENV}
+          else
+              echo "${GITHUB_WORKSPACE}\\skore\\venv\\Scripts" >> ${GITHUB_PATH}
+              echo "VIRTUAL_ENV=${GITHUB_WORKSPACE}\\skore\\venv" >> ${GITHUB_ENV}
+          fi
+
+      - name: Install dependencies in python-venv
+        working-directory: "skore/"
+        if: steps.cache-python-venv.outputs.cache-hit != 'true'
+        run: |
+          python -m pip install --upgrade "pip"
+          python -m pip install --upgrade "build"
+          python -m pip install --upgrade "scikit-learn ==${{ matrix.scikit-learn }}"
+
+          # Install `skore` and its dependencies
+          python -m pip install --upgrade ".[test]"
+
+          # Uninstall the `skore` package itself
+          python -m pip uninstall -y "skore"
+
+      - name: Save python-venv
+        uses: actions/cache/save@v4
+        if: steps.cache-python-venv.outputs.cache-hit != 'true'
+        with:
+          path: 'skore/venv'
+          key: ${{ steps.cache-python-venv.outputs.cache-primary-key }}
 
       - name: Build
         working-directory: skore/
         run: python -m build
 
       - name: Install
         working-directory: skore/
-        run: wheel=(dist/*.whl); python -m pip install "${wheel}[test]"
+        run: |
+          # Install `skore` without its dependencies, which are present in the venv
+          wheel=(dist/*.whl); python -m pip install --force-reinstall --no-deps "${wheel}"
 
       - name: Test without coverage
         if: ${{ ! matrix.coverage }}

diff --git a/.gitignore b/.gitignore
@@ -127,6 +127,10 @@ ENV/
 env.bak/
 venv.bak/
 
+# direnv
+.direnv
+.envrc
+
 # Spyder project settings
 .spyderproject
 .spyproject

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -36,6 +36,7 @@ You'll need ``python >=3.9, <3.13`` to build the backend and ``Node>=20`` to bui
 .. code-block:: bash
 
     make install-skore
+    skore create
     make build-skore-ui
     make serve-skore-ui
 

diff --git a/README.md b/README.md
@@ -4,23 +4,14 @@
     <source srcset="https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/[email protected]" media="(prefers-color-scheme: dark)">
     <img width="200" src="https://media.githubusercontent.com/media/probabl-ai/skore/main/sphinx/_static/images/[email protected]" alt="skore logo">
   </picture>
+  <h3>the scikit-learn sidekick</h3>
 
-  <h2>The scikit-learn Modeling Companion</h2>
-
-__Elevate ML Development with Tracking and Built-in Recommended Practices__ \
+Elevate ML Development with Tracking and Built-in Recommended Practices \
 [Documentation](https://skore.probabl.ai) — [Community](https://discord.probabl.ai)
 
-<br />
-
-  ![license](https://img.shields.io/pypi/l/skore)
-  ![python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue?style=flat&logo=python)
-  [![downloads](https://static.pepy.tech/badge/skore/month)](https://pepy.tech/projects/skore)
-  [![pypi](https://img.shields.io/pypi/v/skore)](https://pypi.org/project/skore/)
-  ![ci](https://github.com/probabl-ai/skore/actions/workflows/ci.yml/badge.svg?event=push)
-  [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.probabl.ai/)
-
 </div>
 
+<br />
 
 ## Why skore?
 
@@ -107,9 +98,17 @@ Thank you for considering contributing to skore! Join our mission to promote ope
 
 ## Feedback & Community
 
--	Join our [Discord](https://discord.probabl.ai/) to share ideas or get support.
--	Request a feature or report a bug via [GitHub Issues](https://github.com/probabl-ai/skore/issues).
+-   Join our [Discord](https://discord.probabl.ai/) to share ideas or get support.
+-   Request a feature or report a bug via [GitHub Issues](https://github.com/probabl-ai/skore/issues).
+
+<br />
 
+  ![license](https://img.shields.io/pypi/l/skore)
+  ![python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue?style=flat&logo=python)
+  [![downloads](https://static.pepy.tech/badge/skore/month)](https://pepy.tech/projects/skore)
+  [![pypi](https://img.shields.io/pypi/v/skore)](https://pypi.org/project/skore/)
+  ![ci](https://github.com/probabl-ai/skore/actions/workflows/ci.yml/badge.svg?event=push)
+  [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.probabl.ai/)
 
 ---
 

diff --git a/docs/design/0002-never-present-neg-metrics-from-sklearn.md b/docs/design/0002-never-present-neg-metrics-from-sklearn.md
@@ -0,0 +1,27 @@
+---
+status: accepted
+date: 2025-01-06
+decision-makers: ["@augustebaum", "@sylvaincom", "@glemaitre"]
+consulted: ["@ogrisel"]
+---
+
+# Never show `neg_*` metrics from sklearn
+
+## Context and Problem Statement
+
+We show various metrics to users, many directly using sklearn.
+In sklearn, many metrics are multiplied by -1 and prefixed with `neg_`, with the purpose of making all metrics "higher-is-better". This way, optimization tools in sklearn such as `GridSearchCV` do not need to figure out which way the metric should be optimized.
+This is specific to sklearn, and there is no reason to port this design over to skore.
+
+## Decision Drivers
+
+* Our data-science-literate collaborators (@ogrisel, @glemaitre, @sylvaincom) consider the `neg_` trick should remain a solution to a sklearn-specific problem, and not be displayed in plots for the skore user.
+
+## Decision Outcome
+
+Chosen option: Never show `neg_*` metrics from sklearn in skore, only use the positive counterparts. This makes reports clearer.
+
+### Consequences
+
+* We show the most relevant information to the user.
+* We might have to take on the responsibility of maintaining the "metric is higher-is-better" pre-condition ourselves.
diff --git a/examples/getting_started/plot_quick_start.py b/examples/getting_started/plot_quick_start.py
@@ -12,7 +12,7 @@
 # %%
 import skore
 
-my_project = skore.create("quick_start", overwrite=True)
+my_project = skore.open("quick_start", overwrite=True)
 
 # %%
 # This will create a skore project directory named ``quick_start.skore`` in your
@@ -42,9 +42,6 @@
 # %%
 reporter.plots.scores
 
-# %%
-reporter.plots.timing_normalized
-
 # %%
 # Finally, from your shell (in the same directory), start the UI:
 #

diff --git a/examples/getting_started/plot_skore_product_tour.py b/examples/getting_started/plot_skore_product_tour.py
@@ -44,7 +44,7 @@
 #
 #     import skore
 #
-#     my_project = skore.create("my_project")
+#     my_project = skore.open("my_project")
 #
 #   This would create a skore project directory named ``my_project.skore`` in our
 #   current directory.
@@ -66,7 +66,7 @@
 # %%
 import skore
 
-my_project = skore.create("my_project", working_dir=temp_dir_path)
+my_project = skore.open(temp_dir_path / "my_project")
 
 # %%
 # Then, *from our shell* (in the same directory), we can start the UI locally:

diff --git a/examples/getting_started/plot_tracking_items.py b/examples/getting_started/plot_tracking_items.py
@@ -30,7 +30,7 @@
 # %%
 import skore
 
-my_project = skore.create("my_project", working_dir=temp_dir_path)
+my_project = skore.open(temp_dir_path / "my_project")
 
 # %%
 # Tracking an integer

diff --git a/examples/getting_started/plot_working_with_projects.py b/examples/getting_started/plot_working_with_projects.py
@@ -30,7 +30,7 @@
 # %%
 import skore
 
-my_project = skore.create("my_project", working_dir=temp_dir_path)
+my_project = skore.open(temp_dir_path / "my_project")
 
 # %%
 # Storing integers

diff --git a/examples/model_evaluation/plot_cross_validate.py b/examples/model_evaluation/plot_cross_validate.py
@@ -30,7 +30,7 @@
 # %%
 import skore
 
-my_project = skore.create("my_project", working_dir=temp_dir_path)
+my_project = skore.open(temp_dir_path / "my_project")
 
 # %%
 # Cross-validation in scikit-learn

diff --git a/examples/model_evaluation/plot_train_test_split.py b/examples/model_evaluation/plot_train_test_split.py
@@ -30,7 +30,7 @@
 # %%
 import skore
 
-my_project = skore.create("my_project", working_dir=temp_dir_path)
+my_project = skore.open(temp_dir_path / "my_project")
 
 # %%
 # Train-test split in scikit-learn

diff --git a/skore-ui/src/assets/fonts/icomoon.eot b/skore-ui/src/assets/fonts/icomoon.eot