Project.put#

Project.put(key, report)[source]

Put a key-report pair to the project.

If the key already exists, its last report is modified to point to this new report, while keeping track of the report history.

Parameters:
keystr

The key to associate with report in the project. Name of the run for mode:mlflow

reportEstimatorReport | CrossValidationReport

The report to associate with key in the project.

Returns:
None

The report is persisted in the project backend.

Examples

>>> from sklearn.datasets import make_regression
>>> from sklearn.linear_model import LinearRegression
>>> from pathlib import Path
>>> from tempfile import TemporaryDirectory
>>> from skore import Project, evaluate
>>> X, y = make_regression(random_state=42)
>>> report = evaluate(LinearRegression(), X, y, splitter=0.2)
>>> tmpdir = TemporaryDirectory()
>>> project = Project(mode="local", name="my-xp", workspace=Path(tmpdir.name))
>>> project.put("my-regression", report)
>>> tmpdir.cleanup()