psf / psf/pyperf

Extend hook's teardown metadata with warmup/calibration flags

Open
#239 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
962
Forks
106
Avg merge
2d 18h
Merged PRs (30d)
4

Description

I'm working on gc-monitor and have implemented a pyperf hook. The hook's teardown function writes collected run data to an intermediate file, but there's currently no way to distinguish between warmup, calibration, and measurement runs.

Would it make sense to extend the metadata dictionary passed to teardown with additional context, such as {"is_warmup": is_warmup, "calibrate_loops": calibrate_loops}?

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.

Research direction

Start by tracing pyperf's hook teardown path and the metadata dictionary passed to teardown, then compare how warmup, calibration, and measurement runs are identified. Define and test the metadata contract so the hook can distinguish those run types and verify that existing intermediate-file output remains correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
performance
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.