Skip to content

Commit 52a9a25

Browse files
Add changelog fragment and document IO-benchmarking conventions
Adds the performance-changelog entry and captures in AGENTS.md the two conventions this effort leaned on: how to write changelog fragments (type by intent — performance work is newfeature; one-sentence entries ending with a contributor name link anchored in names.inc) and the interleaved-A/B benchmarking discipline used to validate these speedups.
1 parent 8321243 commit 52a9a25

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,3 +151,15 @@ changelog entry instead of a plain name link.
151151
# (BSD-compatible).
152152
```
153153
If the license of a snippet cannot be determined, do not adapt it.
154+
155+
- Benchmarking performance changes: only interleaved A/B runs against a
156+
pristine snapshot built from the exact upstream base are trustworthy;
157+
whole-suite back-to-back runs drift ±20–100 %. Verify which installed mne a
158+
benchmark actually imports (`print(mne.__file__)`) before trusting numbers,
159+
and keep fixture data out of commits.
160+
- Changelog fragments (`doc/changes/dev/<PR#>.<type>.rst`): pick `<type>` by
161+
intent — performance improvements are `newfeature`, not `bugfix`. Keep the
162+
entry to one short sentence ending with the contributor name link, e.g.
163+
"Speed up X by optimizing Y, by `Jane Doe`_", and make sure the name anchors
164+
in `doc/changes/names.inc` (add it if missing). Read an existing fragment
165+
or two before writing yours.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Speed up reading by optimizing small read paths, by `Bruno Aristimunha`_

0 commit comments

Comments
 (0)