View Source Benchee.Formatters.Markdown (benchee_markdown v0.3.2)

Functionality for converting Benchee benchmarking results to an HTML page.

Examples

list = Enum.to_list(1..10_000)

map_fun = fn(i) -> [i, i * i] end

Benchee.run(
  %{
    "flat_map" => fn -> Enum.flat_map(list, map_fun) end,
    "map.flatten" => fn -> list |> Enum.map(map_fun) |> List.flatten() end
  },
  formatters: [
    Benchee.Formatters.Console,
    {Benchee.Formatters.Markdown, file: "samples_output/flat_map.html"}
  ]
)

Summary

Functions

Formats the output of benchee to markdown page.

Renders a given %Benchee.Suite{} as makrdown.

Uses the return value of Benchee.Formatters.Markdown.format/2 to write it to the file defined in the initial configuration.

Functions

Formats the output of benchee to markdown page.

Link to this function

render(suite, opts \\ %{})

View Source

Renders a given %Benchee.Suite{} as makrdown.

Uses the return value of Benchee.Formatters.Markdown.format/2 to write it to the file defined in the initial configuration.