docs: INSTRUMENTS.md and PERFORMANCE.md state the bench gate at 5% over five workloads; it is 0.5% over ten

Aperta Adatta ai principianti
  • Qualcosa non va?
#2,282 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown, shell
Ambito
documentation, performance

Direzione di ricerca

Inizia da bench/check_regression.sh (riga 16, THRESHOLD_PCT) e ls bench/*.eigs per confermare la soglia reale e i 10 programmi, quindi confronta con codspeed.yml. Correggi i numeri indicati in docs/INSTRUMENTS.md riga 130 e in docs/PERFORMANCE.md righe 19, 93 e 228-229. Il lavoro è completo quando i documenti riportano la soglia dello 0,5% per --vs, il rapporto 53x, 4 programmi su 10 assenti dalla corsia e 29 casi di autotest.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

area:docs found-by:duet-audit kind:docs-drift

Found by audit area 10 (performance claims), read-only, against main b367cd7.

The register is supposed to be the record of each device's resolution, and two of its numbers now describe an older gate. Each item below was checked against the tree.

Where Says Tree says
docs/INSTRUMENTS.md:130 (CodSpeed row, "Decides") "the required bench job (cachegrind Ir, THRESHOLD_PCT=5, a different instrument) 526 times" the worst A/A spread bench/check_regression.sh:16 THRESHOLD_PCT=0.5 for the --vs mode CI runs (#2072, 2026-10-28). 0.5% / 0.0095% is about 53 times, not 526. (Row 127, the bench row itself, is correct.)
docs/INSTRUMENTS.md:130 ("Population and blind spots") "13 rows (3 of 9 bench/*.eigs programs are not in the lane)" ls bench/*.eigs gives 10; codspeed.yml has 6 of them, so 4 are not in the lane (alloc_heavy, both conservative_*, observer_gate_soft_keyword).
docs/PERFORMANCE.md:19 the bench job "fails on more than a few percent" 0.5% (--vs); 5% only for the local file mode.
docs/PERFORMANCE.md:228-229 the bench job checks "five workloads"; codspeed.yml "declares the same five workloads" The job measures every bench/*.eigs (10); the lane declares 6 bench/ rows (it added unobserved_armed_loop).
docs/PERFORMANCE.md:93 test_string_scaling.sh --selftest # 23 cases == selftest 29 run, 29 passed == (matches the INSTRUMENTS.md row's plants: 29).

Why it matters: the CodSpeed row's ratio is the register's argument that both gates sit far above their resolution. With the real threshold it is 53 times, still comfortably above, but the register should carry the measured number, not one from before #2072.

Done when

  • docs/INSTRUMENTS.md:130 gives the --vs threshold as 0.5% with its ratio to the worst A/A spread, and the lane's population as 4 of 10 bench/*.eigs programs absent.
  • docs/PERFORMANCE.md states the 0.5% --vs threshold, the real workload counts for the job and the lane, and 29 self-test cases.
  • Optional, to stop the next drift: tools/docs_claims_check.sh or performance_observer_docs.py derives these counts and the threshold from the tree instead of prose (the front-door rule already bans derived counts in README/llms.txt).

— Duet (orchestrator)

Lingua principale
C
Stelle
3
Fork
7
Merge medio
6h 21m
PR unite (30g)
323

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di InauguralSystems/EigenScript

Tutte le issue di InauguralSystems/EigenScript

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.