Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bencheeorg/benchee_html
Draw pretty micro benchmarking charts in HTML and allow to export them as png for benchee
https://github.com/bencheeorg/benchee_html
benchee benchmarking formatter graph html plotlyjs plugin
Last synced: about 9 hours ago
JSON representation
Draw pretty micro benchmarking charts in HTML and allow to export them as png for benchee
- Host: GitHub
- URL: https://github.com/bencheeorg/benchee_html
- Owner: bencheeorg
- License: mit
- Created: 2016-09-12T19:37:24.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-27T20:30:52.000Z (11 months ago)
- Last Synced: 2024-10-18T10:54:10.610Z (about 1 month ago)
- Topics: benchee, benchmarking, formatter, graph, html, plotlyjs, plugin
- Language: Elixir
- Homepage:
- Size: 2.5 MB
- Stars: 58
- Watchers: 4
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# benchee_html [](https://hex.pm/packages/benchee_html) [](https://hexdocs.pm/benchee_html/) [](https://github.com/bencheeorg/benchee_html/actions/workflows/main.yml) [](https://coveralls.io/github/bencheeorg/benchee_html?branch=main) [](https://hex.pm/packages/benchee_html) [](https://github.com/bencheeorg/benchee_html/blob/master/LICENSE)
Formatter for [benchee](//github.com/PragTob/benchee) to produce some standalone HTML with nice graphs, a data table etc. from your benchee benchmarking results :) Also allows you to export PNG images, the graphs are also somewhat explorable thanks to [plotly.js](https://plot.ly/javascript/)!
To get a taste of what this is like you can check out an [online example report](http://www.pragtob.info/benchee/README/results_comparison.html) or look at this little screenshot:
It not only generates HTML but also assets and into the same folder. You can just take it and drop it on your server, github pages or public dropbox directory if you want it to be accessible to someone else :)
## Installation
Add `:benchee_html` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:benchee_html, "~> 1.0", only: :dev}
]
end
```
## Usage
Just use it as a formatter for [benchee](https://github.com/PragTob/benchee):
```elixir
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.HTML,
Benchee.Formatters.Console
]
# override defaults:
# formatters: [{Benchee.Formatters.HTML, file: "output/my.html", auto_open: false}]
)
```
The report index page will be written to `"benchmarks/output/results.html"` and opened in your standard browser automatically. Of course you can also optionally specify a tuple of `{Module, options}` to specify a different destination for the reports: `[{Benchee.Formatters.HTML, file: "your_file.html"}]`. Auto open behaviour can be overridden in the same manner: `html: [{Benchee.Formatters.HTML, auto_open: false}]`
Of course it also works with multiple inputs, in that case one file per input is generated:
```elixir
map_fun = fn(i) -> [i, i * i] end
Benchee.run(%{
"flat_map" => fn(list) -> Enum.flat_map(list, map_fun) end,
"map.flatten" => fn(list) -> list |> Enum.map(map_fun) |> List.flatten end
},
formatters: [
{Benchee.Formatters.HTML, file: "samples_output/my.html"},
Benchee.Formatters.Console
],
time: 7,
warmup: 3,
inputs: %{
"Smaller List" => Enum.to_list(1..1_000),
"Bigger List" => Enum.to_list(1..100_000),
}
)
```
When you hover the graphs in the HTML report, quite some plotly.js controls and links appear with which you can navigate in the graph and more.
Be aware, that currently when too many samples are recorded (> 100_000 usually) rendering might break as plotly can't handle all that data. See [this issue](https://github.com/PragTob/benchee_html/issues/3) on how to quick fix it and what could be done in the future.
## PNG image export/download
When you hover the graph the controls appear and the left most of those is a camera and says "Download plot as png" - and it does what you'd expect. Refer to the image below if you need more guidance :)
## A look at graphs
In the wiki there is a page [providing an overview of the differnt chart types benchee_html produces](https://github.com/PragTob/benchee_html/wiki/Chart-Types).
For the ones that just want to scroll through, here they are once more.
### IPS Bar Chart
### Run Time Boxplot
### Run Time Histogram
### Raw run times
## Contributing
Contributions to benchee_html are very welcome! Bug reports, documentation, spelling corrections, whole features, feature ideas, bugfixes, new plugins, fancy graphics... all of those (and probably more) are much appreciated contributions!
Please respect the [Code of Conduct](//github.com/PragTob/benchee_html/blob/master/CODE_OF_CONDUCT.md).
You can get started with a look at the [open issues](https://github.com/PragTob/benchee_html/issues).
A couple of (hopefully) helpful points:
* Feel free to ask for help and guidance on an issue/PR ("How can I implement this?", "How could I test this?", ...)
* Feel free to open early/not yet complete pull requests to get some early feedback
* When in doubt if something is a good idea open an issue first to discuss it
* In case I don't respond feel free to bump the issue/PR or ping me on other places
## Development
* `mix deps.get` to install dependencies
* `mix test` to run tests
* `mix credo` or `mix credo --strict` to find code style problems (not too strict with the 80 width limit for sample output in the docs)
## Copyright and License
Copyright (c) 2016 Tobias Pfeiffer
This library is released under the MIT License. See the [LICENSE.md](./LICENSE.md) file
for further details.