citrine.resources.report module

A resource that represents a single module report.

class citrine.resources.report.ReportResource(project_id: UUID, session: Session)

Bases: Resource[ReportResource]

Defines a resource for fetching reports from a module.

Parameters:

project_id (UUID) – the UUID of the project

access_control_dict() → dict

Return an access control entity representation of this resource. Internal use only.

classmethod build(data: dict) → Self

Build an instance of this object from given data.

dump() → dict

Dump this instance.

get(*, predictor_id: UUID | str, predictor_version: int | str | None = None) → Report

Gets a single report keyed on the predictor ID and (optionally) version.