Skip to content

Docs: readable evidence, rendered math with scope, remove audit page, add downloads badge - #19

Merged
soodoku merged 4 commits into
mainfrom
claude/vibrant-heisenberg-osft1o
Sep 29, 2026
Merged

soodoku merged 4 commits into
mainfrom
claude/vibrant-heisenberg-osft1o

Conversation

@soodoku

@soodoku soodoku commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Evidence page (benchmarks/render.py, docs/evidence.md):
    • Brier differences are shown as % change with a plain verdict ("streamcal better" / "no clear difference").
    • Known-truth errors are shown in percentage points instead of 5-decimal MSEs.
    • Sizes are in B/KB, latencies are rounded, and methods have readable names instead of config strings.
    • The prose now leads with the findings.
    • Fixed a malformed resource table (7 alignment cells for 6 columns).
    • The main table now shows saved size, because River keeps its state in dicts and showed as "0 B" of arrays.
  • Formalization page:
    • Enabled MyST dollarmath/amsmath, so equations render with MathJax instead of plain-text blocks.
    • Formalized per-update decay, which the page skipped.
    • Added a Scope section: what is proved exactly, what it depends on, and what is not claimed (unbinned equivalence, statistical guarantees, drift tracking, outcome-dependent label arrival).
  • Removed docs/audit.md (/audit.html) and its toctree entry.
  • README: added a pepy.tech downloads badge in the same format as the other finite-sample packages.

Validation

  • Tables: regenerated from the same committed JSON; no benchmark was rerun. Each figure in the new prose (−51%, 9 of 11, ~1/5 and <1/400 state, 1.01 ms over-budget time) was checked against the JSON.
  • Docs build: sphinx-build -W passes. In headless Chromium, 77 math elements render with no raw LaTeX left. The built site has no audit.html and no links to it.
  • Checks: ruff check and ruff format --check pass; pytest: 144 passed. Both badge URLs return 200.

🤖 Generated with Claude Code

https://claude.ai/code/session_011pXaJ5DLex7BrdUyfTqjL4

Matches the badge the other finite-sample packages carry.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011pXaJ5DLex7BrdUyfTqjL4
It read as an internal changelog of past defects rather than user
documentation. The only link to it was the docs toctree.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011pXaJ5DLex7BrdUyfTqjL4
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-29T01:27:19.571754Z e10cb1a New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Enable MyST dollarmath/amsmath so equations render with MathJax instead
of plain-text blocks, and rewrite the page in LaTeX. Formalize the
per-update decay mode, which the page skipped, and add a Scope section
separating what is proved exactly, what it depends on, and what is not
claimed (unbinned equivalence, statistical guarantees, drift tracking,
outcome-dependent label arrival).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011pXaJ5DLex7BrdUyfTqjL4
Render Brier differences as percentage changes with a plain verdict,
known-truth errors in percentage points, sizes in B/KB and latencies
rounded to what matters, with method names instead of config strings.
Show saved size in the main table, since River's dict state reads as
0 bytes of arrays. Fix the resource table's extra alignment column.
Rewrite the prose to lead with findings. Tables are regenerated from
the same committed JSON; no benchmark was rerun.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011pXaJ5DLex7BrdUyfTqjL4
@soodoku soodoku changed the title Add pepy downloads badge; remove the audit docs page Docs: readable evidence, rendered math with scope, remove audit page, add downloads badge Sep 29, 2026
@soodoku
soodoku merged commit 313a0b0 into main Sep 29, 2026
11 checks passed
@soodoku
soodoku deleted the claude/vibrant-heisenberg-osft1o branch September 29, 2026 01:25

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e10cb1a146

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread benchmarks/render.py
if point["test_resource_feasible"]:
held = "yes"
else:
held = f"no ({point['test']['p95_update_ms']:.2f} ms)"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Handle operating points with no feasible selection

When the validation budget admits no method, electricity() in benchmarks/suite.py deliberately records selected, test, and test_resource_feasible as None. This falsey branch then indexes point["test"], causing python -m benchmarks.render to fail with a TypeError instead of emitting the intended “nothing fits” row. Handle the None case before formatting the failed-budget detail.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants