Skip to content

Statistics module

Reference to the schema.statistics.py module.

statistics

Schema for statistics.

RunStatistics

Bases: BaseModel

Statistics about a general run.

PARAMETER DESCRIPTION

duration

Duration of the run in seconds.

TYPE: float

iterations

Number of iterations.

TYPE: int

custom

Custom statistics created by the user. Can normally expect a Dict[str, Any].

TYPE: Union[Any, Dict[str, Any]]

duration class-attribute instance-attribute 

duration: float | None = None

Duration of the run in seconds.

iterations class-attribute instance-attribute 

iterations: int | None = None

Number of iterations.

custom class-attribute instance-attribute 

custom: Any | dict[str, Any] | None = None

Custom statistics created by the user. Can normally expect a Dict[str, Any].

ResultStatistics

Bases: BaseModel

Statistics about a specific result.

PARAMETER DESCRIPTION

duration

Duration of the run in seconds.

TYPE: float

value

Value of the result.

TYPE: float

custom

Custom statistics created by the user. Can normally expect a Dict[str, Any].

TYPE: Union[Any, Dict[str, Any]]

duration class-attribute instance-attribute 

duration: float | None = None

Duration of the run in seconds.

value class-attribute instance-attribute 

value: float | None = None

Value of the result.

custom class-attribute instance-attribute 

custom: Any | dict[str, Any] | None = None

Custom statistics created by the user. Can normally expect a Dict[str, Any].

DataPoint

Bases: BaseModel

A data point.

PARAMETER DESCRIPTION

x

X coordinate of the data point.

TYPE: float

y

Y coordinate of the data point.

TYPE: float

x instance-attribute 

x: float

X coordinate of the data point.

y instance-attribute 

y: float

Y coordinate of the data point.

Series

Bases: BaseModel

A series of data points.

PARAMETER DESCRIPTION

name

Name of the series.

TYPE: str

data_points

Data of the series.

TYPE: List[DataPoint]

name class-attribute instance-attribute 

name: str | None = None

Name of the series.

data_points class-attribute instance-attribute 

data_points: list[DataPoint] | None = None

Data of the series.

SeriesData

Bases: BaseModel

Data of a series.

PARAMETER DESCRIPTION

value

A series for the value of the solution.

TYPE: Series

custom

A list of series for custom statistics.

TYPE: List[Series]

value class-attribute instance-attribute 

value: Series | None = None

A series for the value of the solution.

custom class-attribute instance-attribute 

custom: list[Series] | None = None

A list of series for custom statistics.

Statistics

Bases: BaseModel

Statistics of a solution.

PARAMETER DESCRIPTION

run

Statistics about the run.

TYPE: RunStatistics

result

Statistics about the last result.

TYPE: ResultStatistics

series_data

Series data about some metric.

TYPE: SeriesData

statistics_schema

Schema (version). This class only supports v1.

TYPE: str

run class-attribute instance-attribute 

run: RunStatistics | None = None

Statistics about the run.

result class-attribute instance-attribute 

result: ResultStatistics | None = None

Statistics about the last result.

series_data class-attribute instance-attribute 

series_data: SeriesData | None = None

Data of the series.

statistics_schema class-attribute instance-attribute 

statistics_schema: str | None = Field(
    alias="schema", default="v1"
)

Schema (version). This class only supports v1.