simplebench.reporters.csv.reporter.options package🔗

CSV Reporter options package for simplebench.

class simplebench.reporters.csv.reporter.options.CSVField(value)[source]🔗

Bases: str, Enum

Fields available for CSV reporter output.

ELAPSED_SECONDS = 'Elapsed Seconds'🔗

The total elapsed time in seconds.

ITERATIONS = 'Iterations'🔗

The number of iterations performed.

MAX = 'max'🔗

The statistical maximum value.

MEAN = 'mean'🔗

The statistical mean value.

MEDIAN = 'median'🔗

The statistical median value.

MIN = 'min'🔗

The statistical minimum value.

N = 'N'🔗

The O() complexity value.

P5 = '5th'🔗

The statistical 5th percentile.

P95 = '95th'🔗

The statistical 95th percentile.

ROUNDS = 'Rounds'🔗

The number of rounds performed.

RSD_PERCENT = 'rsd%'🔗

The relative standard deviation percentage.

STD_DEV = 'std dev'🔗

The adjusted standard deviation of operation times.

class simplebench.reporters.csv.reporter.options.CSVOptions(
fields: Sequence[CSVField] | None = None,
variation_cols_last: bool = False,
)[source]🔗

Bases: ReporterOptions

Class for holding CSV reporter specific options in a Choice.

This class provides additional configuration options specific to the JSON reporter. It is accessed via the options attribute of a Choice instance.

Parameters:

  • fields –

    A tuple of CSV fields to include in the output. If none is specifically set, a predefined set of fields is used. The fields appear in the order specified in the sequence.

    If specified, all fields must be from the CSVField enum.

    The default fields, in order, are:

  • variation_cols_last – Whether to place the variation columns (if any) at the end of the rows. Defaults to False - which places the variation columns at the start of the rows.

Raises:

Initialize CSVOptions instance.

property fields: tuple[CSVField, ...]🔗

Return the fields, in order, to include in the CSV table when rendering.

Returns:

A tuple of CSVField enums representing the default fields.

property variation_cols_last: bool🔗

Return whether variation columns are placed at the end of the rows.

Returns:

True if variation columns are placed at the end, False if at the start.

Submodules🔗