Managing a project

Skore project

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

Project(name, **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(), a Summary object is returned. This object is a pandas.DataFrame with a specific HTML representation to allow you filter and retrieve the reports.

project.summary.Summary([data, index, ...])

Metadata and metrics for all reports persisted in a project at a given moment.

project.summary.Summary.reports(*[, filter, ...])

Return the reports referenced by the summary object from the project.

Note

This class Summary is not meant to be used directly. Instead, use the method Project.summarize().