Benchee v1.0.1 Benchee.Suite View Source
Main benchee data structure that aggregates the results from every step.
Different layers of the benchmarking rely on different data being present
here. For instance for Benchee.Statistics.statistics/1
to work the
run_time_data
key of each scenario needs to be filled with the samples
collected by Benchee.Benchmark.collect/1
.
Formatters can then use the data to display all of the results and the configuration.
Link to this section Summary
Types
Valid key for either input or benchmarking job names
The main suite consisting of the configuration data, information about the system and most
importantly a list of Benchee.Scenario.t/0
Link to this section Types
key() View Source
Valid key for either input or benchmarking job names.
t()
View Source
t() :: %Benchee.Suite{
configuration: Benchee.Configuration.t() | nil,
scenarios: [] | [Benchee.Scenario.t()],
system: map() | nil
}
t() :: %Benchee.Suite{ configuration: Benchee.Configuration.t() | nil, scenarios: [] | [Benchee.Scenario.t()], system: map() | nil }
The main suite consisting of the configuration data, information about the system and most
importantly a list of Benchee.Scenario.t/0
.