Skip to content
Benche formatter to output markdown
Branch: master
Clone or download

README.md

BencheeMarkdown

Build Status Coverage Status License: MIT

Benchee formatter to output markdown. A very early beta version.

Installation

Add benchee_markdown to your list of dependencies in mix.exs:

def deps do
  [{:benchee_markdown, "~> 0.1", only: :dev}]
end

Afterwards, run mix deps.get to install it.

Usage

Simply configure Benchee.Formatters.Markdown as one of the formatters for Benchee.run/2 along with the file path you want the output to go.

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.Markdown, file: "my.md"},
    Benchee.Formatters.Console
  ]

The sample defines both the standard console formatter and the markdown formatter, if you don't care about the console output you can just delete that line.

Examples

An example can been seen at examples/bench/basic.

You can’t perform that action at this time.