Managing a project

Skore project

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

login(*[, mode])

Log in to Skore Hub for the duration of the session (e.g. script).

Project(name, *[, mode])

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 object that holds the metadata and metrics of the stored reports as a pandas.DataFrame (accessible via its frame() method) and renders an interactive table in Jupyter-like environments to filter and retrieve the reports.

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

Summary(dataframe[, project])

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

Methods

Summary.frame(*[, report_type])	Return the metadata and metrics as a pandas.DataFrame.
Summary.query(expr)	Filter the summary using a pandas.DataFrame.query() expression.
Summary.compare(*[, return_as])	Return the reports referenced by the summary object from the project.