docs(readme): document the green software engineering programme - #508
Merged
Merged
Conversation
Thirteen merged PRs (#475-#487, #506) and a full SCI-grounded energy harness under benchmarks/energy/ had no mention anywhere in the README. A reader had no way to know the programme existed, which also meant no way to hold it to its own evidence rule. The section states what the harness measures and, at equal length, what it does not: its own README opens by saying the fixtures do not measure device energy and do not establish an energy improvement, the carbon factors are mandatory operator inputs with no defaults, and the boundary is the sensor's CPU+GPU+ANE estimate excluding memory, storage, screen and power-supply losses. No energy figure is published, and the section says why: no energy results are committed to this repository, because a number measured on one operator's machine, region and duty cycle is not a property of the software. The demand-reduction paragraph is explicitly labelled a design rationale rather than a measurement, since no end-to-end token-savings or CO2 figure has been measured. The one quantitative claim is the already-committed hook boot constant (~0.05s vs ~0.6s registry import, measured 2026-07-28), cited to its call sites in mcp_server/hooks/auto_recall.py. check_doc_claims.py exits 0. Co-Authored-By: Claude Opus 5 <[email protected]> Claude-Session: https://claude.ai/code/session_01StMBvNd7eVJGtpnC2zNsx1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Thirteen merged PRs (#475–#487, #506) and a full SCI-grounded energy harness under
benchmarks/energy/had no mention anywhere in the README. A reader had no way to know the programme existed — which also meant no way to hold it to its own evidence rule.What the section says
A new
## Green software engineeringsection, placed before## Verificationso the claims-discipline sections sit together.The harness, and what it does not establish.
benchmarks/energy/implements the GSF SCI specification (O = E × I,M = TE × TS × RS), functional unit = 1000 model input tokens counted from the tokenizer's ownattention_mask. The section then spends equal space on the limits, taken from the harness's own README:--carbon-intensityand--embodiedare mandatory operator inputs, validated before any model import, and the harness does not vouch for their provenance;results.json,MANIFEST.json, the analyzedpowermetrics.txt).No energy figure is published, and the section says why: no energy results are committed here, because a number measured on one operator's machine, region and duty cycle is not a property of the software, and publishing it as one would be exactly the drift this programme exists to prevent.
What actually shipped — a table of the merged CI/build and runtime PRs, each linked.
Demand reduction is presented as the primary lever, and the paragraph is explicitly labelled a design rationale, not a measurement, with a closing sentence stating that Cortex publishes no token-savings or CO₂ figure for end-to-end agent sessions because it has not measured one.
The one quantitative claim
Hook boot ~0.05 s vs ~0.6 s for the full registry import (measured 2026-07-28) — an already-committed constant, cited to its call sites in
mcp_server/hooks/auto_recall.py:247,300, per the no-invented-constants rule.Verification
Each cited fact was checked against its source file, not against prose:
attention_maskbenchmarks/energy/README.mdbenchmarks/results/energy/— confirmed absentCORTEX_RERANKER_OFFLINEmcp_server/core/reranker_model.py:66mcp_server/core/response_budget.pypython3 scripts/check_doc_claims.pyexits 0. Documentation only — no code, no behaviour change.🤖 Generated with Claude Code
https://claude.ai/code/session_01StMBvNd7eVJGtpnC2zNsx1
Generated by Claude Code