simplebench.reporters.csv.reporter.options.options module

ReporerOptions subclass for CSV reporter specific options.

This module defines the CSVOptions class, which is a subclass of ReporterOptions and is used to hold options specific to the CSV reporter.

class simplebench.reporters.csv.reporter.options.options.CSVOptions(

fields: Sequence[CSVField] | None = None,

variation_cols_last: bool = False,

)

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:

  • N

  • ITERATIONS

  • ROUNDS

  • ELAPSED_SECONDS

  • MEAN

  • MEDIAN

  • MIN

  • MAX

  • P5

  • P95

  • STD_DEV

  • RSD_PERCENT

• 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:

• SimpleBenchTypeError – Any parameter is of an invalid type.

• SimpleBenchValueError – If fields is an empty sequence.

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.