google/benchmark

[FR] human readable name of benchmark

Open

#1,006 opened on Jul 21, 2020

View on GitHub
 (0 comments) (4 reactions) (0 assignees)C++ (1,539 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (7,968 stars)
PR merge metrics
 (Avg merge 4d 2h) (19 merged PRs in 30d)

Description

https://github.com/google/benchmark#running-a-subset-of-benchmarks As shown in the readme.md, https://github.com/google/benchmark/blame/master/README.md#L424

The benchmark name contains the state.range values as human readable format. (eg. 32k) But the current code does not provide any switches or automatic way to format these numbers to human readable format.

Benchmark              Time           CPU Iterations
----------------------------------------------------
BM_memcpy/32          11 ns         11 ns   79545455
BM_memcpy/32k       2181 ns       2185 ns     324074

Describe the solution you'd like Provide a function to enable human readable names for benchmark names. for powers of 2 and powers of 10.

Contributor guide

Research direction
Examine how benchmark names are currently constructed (e.g., from state.range values) and implement a function to convert numeric ranges to human readable strings for powers of 2 (e.g., 32k) and powers of 10.
Tech stack
cpp
Domain
toolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Benchmark library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75