Managing a project#

Skore project#

These functions and classes are meant for managing a Project and its reports.

Project(name, *, mode, **kwargs)

API to manage a collection of key-report pairs.

Methods

Project.put(key, report)

Put a key-report pair to the project.

Project.get(id)

Get a persisted report by its id.

Project.summarize()

Obtain metadata/metrics for all persisted reports.

Skore project’s summary#

When calling Project.summarize(), returns a summary table as a pandas.DataFrame with a specific HTML representation to allow you to filter and retrieve the reports.

The returned object is not intended to be instantiated or imported directly. Always use Project.summarize().