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.

Sign up for GitHub

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

Jump to bottom

docs: add information about benchmarking #2001

Merged
merged 1 commit into from Sep 10, 2022
Merged

docs: add information about benchmarking #2001

merged 1 commit into from Sep 10, 2022

Conversation

sheremet-va
Copy link
Member

@sheremet-va sheremet-va commented Sep 8, 2022 •
edited

Closes #1997

I've added minimum information that I could gather. @antfu @poyoho, please, if you have anything to add, feel free to push to this PR

nickmccurdy
nickmccurdy suggested changes Sep 8, 2022
View reviewed changes
Copy link
Contributor

@nickmccurdy nickmccurdy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good so far. It could be nice to have some info on what the CLI output means too, especially for users not familiar with benchmarking or statistics.

poyoho
poyoho approved these changes Sep 8, 2022
View reviewed changes
Copy link
Member

@poyoho poyoho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@Aslemammad
Copy link
Member

Is it possible to include tinybench in the main doc file, like what is with tinyspy and tinybench? Thanks.

@antfu antfu merged commit f00a1ac into main Sep 10, 2022
@antfu antfu deleted the docs/bench branch September 10, 2022 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nickmccurdy nickmccurdy nickmccurdy requested changes

@antfu antfu antfu approved these changes

@poyoho poyoho poyoho approved these changes

@Demivan Demivan Awaiting requested review from Demivan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing docs for bench CLI and API
5 participants
@sheremet-va @Aslemammad @nickmccurdy @antfu @poyoho