Include an overall summary number in compare output

Open
#204 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli, performance

Research direction

Start by locating the pyperformance compare command and reviewing how it currently reports per-benchmark change factors and significance. Clarify the aggregation rule with maintainers, then define completion as a documented overall summary number printed consistently by compare.

Written by the indexing model from the issue text.

Description

People often quote a single perf number when comparing versions (e.g. "Python 3.11 is 25% faster than Python 3.10")

The pyperformance compare command prints out the "change factor" per benchmark. It's not clear how to go from this list of numbers to a single overall number. Having the compare command compute and print it out would also help with consistency when quoting this single perf number (is it mean? geometric mean? only including significant results or all of them?)

Dominant language
Python
Stars
1k
Forks
203
Avg merge
1h 20m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/pyperformance

All issues in python/pyperformance

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.