Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include benchmarks in README.md #8

Open
philippeitis opened this issue Dec 16, 2021 · 0 comments
Open

Include benchmarks in README.md #8

philippeitis opened this issue Dec 16, 2021 · 0 comments

Comments

@philippeitis
Copy link

philippeitis commented Dec 16, 2021

It would be helpful to include sample benchmark results (probably as X times speedup at each size, maybe in graph format?) in the README so that users could have context for what performance gains can be expected (and whether everything performs as expected).

If I have time, I can compile some results, but I don't know if there's a convenient criterion API to generate such a table automatically (it does produce JSON files, which could be tablulated using a script).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant