simplebench.reporters.csv.reporter.config module🔗

Configuration for a CSVReporter.

class simplebench.reporters.csv.reporter.config.CSVConfig(
*,
name: str | None = None,
description: str | None = None,
sections: Iterable[Section] | None = None,
targets: Iterable[Target] | None = None,
default_targets: Iterable[Target] | None = None,
formats: Iterable[Format] | None = None,
choices: ChoicesConf | None = None,
file_suffix: str | None = None,
file_unique: bool | None = None,
file_append: bool | None = None,
subdir: str | None = None,
)[source]🔗

Bases: ReporterConfig

Configuration for a CSVReporter.

This class inherits from ReporterConfig and provides a type-safe, discoverable interface for overriding the default settings of a CSVReporter.

By default, the CSVReporter is configured to output benchmark results to CSV files in the filesystem, with options to also output to console and via callback. The default sections included are OPS, TIMING, MEMORY, and PEAK_MEMORY.

Initialize the CSVReporter configuration.

Accepts keyword arguments to override any of the default configurations. All arguments are optional. If not provided, the default value for CSVReporter will be used.