Skip to content

docs: correct stale α = 0.044·‖resid‖ dose refs in the README body - #45

Merged
bamdadd merged 1 commit into
bamdadd:mainfrom
dchaudhari7177:docs/correct-dose-refs
Jul 22, 2026
Merged

docs: correct stale α = 0.044·‖resid‖ dose refs in the README body#45
bamdadd merged 1 commit into
bamdadd:mainfrom
dchaudhari7177:docs/correct-dose-refs

Conversation

@dchaudhari7177

Copy link
Copy Markdown
Contributor

Closes #27.

The headline dose was corrected to α = 2·‖raw diff-of-means‖ (the default dose_mode="raw_norm", the paper's canonical strength 2), but three README body spots still presented the superseded α = 0.044·‖resid‖ as the current method:

  • the Python quickstart comment (# inject @0.61 depth, …),
  • the mermaid diagram node,
  • the Injection depth & strength paragraph.

All three now state the corrected α = 2·‖raw diff-of-means‖, and the paragraph reframes 0.044·‖resid‖ as the superseded resid_frac option (not the default), linking the superseded appendix. Verified against DOSE_MODE_DEFAULT = "raw_norm" / DEFAULT_STRENGTH_K = 2.0 in harness.py.

Acceptance: no remaining bare 0.044·‖resid‖ presented as current; the one leftover reference is explicitly marked superseded. Docs only.

The headline dose was corrected to α = 2·‖raw diff-of-means‖ (raw_norm
mode, the paper's canonical strength 2; RESULTS.md), but three README
body spots still presented the superseded α = 0.044·‖resid‖ as current:
the quickstart comment, the mermaid diagram node, and the 'Injection
depth & strength' paragraph.

Update all three to the corrected dose and reframe 0.044·‖resid‖ as the
superseded, non-default resid_frac option, linking the superseded
appendix. Docs only.

Closes bamdadd#27
@bamdadd
bamdadd merged commit de5e646 into bamdadd:main Jul 22, 2026
1 check passed
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.

Update stale α=0.044·‖resid‖ dose references in the README body

3 participants