Skip to main content

Tooling and assistance for data scientists to "Own Your Data Science"

Project description

👋 Welcome to skore

ci python pypi downloads license Discord

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() and skore.train_test_split() provide insights and checks on cross-validation and train-test-split.

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! Feedbacks are welcome: please feel free to join our Discord.

GIF: short demo of skore

⚙️ 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

🚀 Quick start

Note: For more information on how and why to use skore, see our documentation.

Manipulating the skore UI

  1. From your Python code, create and load a skore project, here named my_project:
import skore
my_project = skore.create("my_project")

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

  1. Start storing some items, for example you can store an integer:
project.put("my_int", 3)

or the result of a scikit-learn grid search:

import numpy as np
from sklearn.datasets import load_diabetes
from sklearn.linear_model import Ridge
from sklearn.model_selection import GridSearchCV

diabetes = load_diabetes()
X = diabetes.data[:150]
y = diabetes.target[:150]

gs_cv = GridSearchCV(
    Ridge(),
    param_grid={"alpha": np.logspace(-3, 5, 50)},
    scoring="neg_root_mean_squared_error",
)
gs_cv.fit(X, y)

my_project.put("my_gs_cv", gs_cv)
  1. 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.

Get assistance when developing your ML/DS projects

By using skore.cross_validate():

import skore
my_project = skore.create("my_project")

from sklearn.datasets import load_iris
from sklearn.svm import SVC

X, y = load_iris(return_X_y=True)
clf = SVC(kernel="linear", C=1, random_state=0)

cv_results = skore.cross_validate(clf, X, y, cv=5, project=my_project)

You will automatically be able to visualize some key metrics (although you might have forgotten to specify all of them): GIF: short demo of skore

There is also a train-test split function that enhances scikit-learn. See more in our documentation.

🔨 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

Probabl logo

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skore-0.4.0.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

skore-0.4.0-py3-none-any.whl (3.3 MB view details)

Uploaded Python 3

File details

Details for the file skore-0.4.0.tar.gz.

File metadata

  • Download URL: skore-0.4.0.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for skore-0.4.0.tar.gz
Algorithm Hash digest
SHA256 80c90575d862ff608790b15d88a8ac76307fb7feb2074fce34e93401f56e4006
MD5 6e72dfd59433391949fc9b116e6c74fa
BLAKE2b-256 67752c8ae3e3a4818ee55f233011e485554b449560aa804d77fa8b113b3c589c

See more details on using hashes here.

Provenance

The following attestation bundles were made for skore-0.4.0.tar.gz:

Publisher: release.yml on probabl-ai/skore

Attestations:

File details

Details for the file skore-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: skore-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for skore-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c4c0ad85444c9a42c104818ed0b3b236c3e04358f7a848152d79fc03dc484b29
MD5 9d063b46622fd6b63c2d8f3824a74932
BLAKE2b-256 974be84e8f642f38dffd3a7960ce6bdeaf5996bd32b893006ca87980b388776a

See more details on using hashes here.

Provenance

The following attestation bundles were made for skore-0.4.0-py3-none-any.whl:

Publisher: release.yml on probabl-ai/skore

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page