👋 Welcome to skore

With skore, data scientists can:

1. Track and visualize their ML/DS results.
2. Get assistance when developing their ML/DS projects.
   • Scikit-learn compatible skore.cross_validate() provides insights and checks on cross-validation.

These are only the first features: skore is a work in progress and aims to be an end-to-end library for data scientists. Stay tuned, and join our Discord if you want to give us feedback!

⚙️ Installation

First of all, we recommend using a virtual environment (venv). You need python>=3.9.

Then, you can install skore by using pip:

pip install -U skore

Warning: For Windows users, the encoding must be set to UTF-8: see PYTHONUTF8.

🚀 Quick start

(For more information on how and why to use skore, see our documentation.)

1. From your shell, initialize a skore project, here named my_project:

skore create "my_project"

This will create a skore project directory named my_project.skore in your current working directory.

2. Now that the project file exists, from your Python code (in the same directory), load the project so that you can read from and write to it, for example you can store an integer:

from skore import load
project = load("my_project.skore")
project.put("my_int", 3)

3. Finally, from your shell (in the same directory), start the UI locally:

skore launch "my_project"

This will automatically open a browser at the UI's location:

1. On the top left, by default, you can observe that you are in a View called default. You can rename this view or create another one.
2. From the Items section on the bottom left, you can add stored items to this view, either by clicking on + or by doing drag-and-drop.
3. In the skore UI on the right, you can drag-and-drop items to re-order them, remove items, etc.

🔨 Contributing

Thank you for your interest! See CONTRIBUTING.rst.

💬 Where to ask questions

Type	Platforms
🐛 Bug reports	GitHub Issue Tracker
✨ Feature requests and ideas	GitHub Issue Tracker & Discord
💬 Usage questions, discussions, contributions, etc	Discord

---

Brought to you by