Benchee v0.2.0 Benchee
Top level module providing convenience access to needed functions as well
as the very high level Benchee.run
API.
Summary
Functions
Convenience access to Benchee.Benchmark.benchmark/3
to define the benchmarks
to run in this benchmarking suite.`
Convenience access to Benchee.Config.init/1
to initialize the configuration
Convenience access to Benchee.Benchmark.measure/1
to run the defined
benchmarks and measure their run time
High level interface that runs the given benchmarks and prints the results on
the console. It is given an optional config and an array of tuples
of names and functions to benchmark. For configuration options see the
documentation of Benchee.Config.init/1
Convenience access to Benchee.Statistics.statistics/1
to generate
statistics
Functions
Convenience access to Benchee.Benchmark.benchmark/3
to define the benchmarks
to run in this benchmarking suite.`
Convenience access to Benchee.Config.init/1
to initialize the configuration.
Possible options:
- time - total run time in seconds of a single benchmark (determines how often it is executed). Defaults to 5.
- warmup - the time in seconds for which the benchmarking function should be run without gathering results. Defaults to 2.
Convenience access to Benchee.Benchmark.measure/1
to run the defined
benchmarks and measure their run time.
High level interface that runs the given benchmarks and prints the results on
the console. It is given an optional config and an array of tuples
of names and functions to benchmark. For configuration options see the
documentation of Benchee.Config.init/1
.
Examples
Benchee.run(%{time: 3},
[{"My Benchmark", fn -> 1 + 1 end},
{"My other benchmrk", fn -> "1" ++ "1" end}])
# Prints a summary of the benchmark to the console
Convenience access to Benchee.Statistics.statistics/1
to generate
statistics.
Examples
iex> run_times = [200, 400, 400, 400, 500, 500, 700, 900]
iex> suite = %{run_times: [{"My Job", run_times}]}
iex> Benchee.Statistics.statistics(suite)
[{"My Job",
%{average: 500.0,
ips: 2000.0,
std_dev: 200.0,
std_dev_ratio: 0.4,
std_dev_ips: 800.0,
median: 450.0}}]