Storing data science artifacts#

skore provides a Project class to store data science artifacts. The storage is either local or remote, based on the value passed to the parameter name at the initialization. When name is set to the form of the URI hub://<tenant>/<name>, the project is configured to the hub mode to communicate with the skore hub. Refer to the documentation of Project for the detailed API.

Once a project is created, store EstimatorReport via the method Project.put().

To retrieve the reports stored in the project, use the project summary by calling the method Project.summarize(). This method returns a Summary instance that presents a rich HTML representation in interactive Jupyter-like environments. A parallel coordinates plot is shown to filter the reports based on different criteria. Once the reports are filtered on the parallel coordinates plot, retrieve the reports by calling the method reports() from the Summary instance. This method returns a list of EstimatorReport instances.

To retrieve a specific report for which you have its id, use the method Project.get() to retrieve the EstimatorReport.