Skip to content

docs(agents): rate analyze, manage, simulate, and probe as Supervised - #270

Merged
amirhs1 merged 1 commit into
mainfrom
docs/supervised-tiers
Nov 9, 2026
Merged

amirhs1 merged 1 commit into
mainfrom
docs/supervised-tiers

Conversation

@amirhs1

@amirhs1 amirhs1 commented Nov 9, 2026

Copy link
Copy Markdown
Owner

Summary

The AI tier tables now rate polyphys/analyze/, manage/, simulate/,
and probe/ as Supervised, which describes how their 1.0 modules were
made: an AI agent drafted them against the maintainer's acceptance
criteria, and the maintainer read every line. The maintainer chose
Supervised on 2026-11-08.

Related issues

Closes #269

Problem

README.md, "AI assistance", and AGENTS.md, "Where you may write",
rated these four parts Instrumented: "not first drafts of core logic".
That disagreed with how the ported modules were written.

What changed

  • README.md:267-270: the four rows say Supervised, and "maintainer
    review of every line"; README.md:278, "Tiers last reviewed:
    2026-11-08". The table's last column is realigned, so the diff shows
    every row.
  • AGENTS.md:157-160: the four rows say Supervised, with the role the
    file already gives an unlisted, Supervised path: "Draft against
    acceptance criteria the maintainer set; every line is read."
  • CHANGELOG.md: one "Changed" line under [Unreleased].

Checks run

  • python -m flake8 polyphys projects → exit 0
  • python -m mypy polyphys/analyze polyphys/manage polyphys/probe polyphys/simulate projects → Success: no issues found in 43 source files
  • Full test command, without POLYPHYS_DATA_DIR → 2703 passed, 61 skipped in 55.98s (the README doctest included)

Not verified: nothing beyond the gate; no code changed.

  • python -m flake8 polyphys projects
  • python -m mypy polyphys/analyze polyphys/manage polyphys/probe polyphys/simulate projects
  • python -m pytest polyphys README.md projects --cov=polyphys --cov-report=term-missing --cov-report=xml --doctest-modules --doctest-glob='README.md'
  • python -m build if packaging metadata, package data, or package layout changed: not changed
  • python -m sphinx -W -b html docs/source docs/_build if docs/source/ changed: not changed
  • CHANGELOG.md has an entry under [Unreleased], or this pull request needs none (CONTRIBUTING.md, "Changelog")

Scientific correctness

  • Measurement and statistics behavior is unchanged, or the change is explained above with how it was validated
  • Units, numerical fixtures, and domain assumptions are preserved or explained
  • Parser lineage and organizer vocabulary are unchanged, or matching parser tests/docs were updated

Documentation of AI use only.

Decisions and risks

  • polyphys/viz/, polyphys/tests/ with .github/workflows/ and
    pyproject.toml, and docs/ stay Instrumented; the maintainer may
    change them separately.
  • How would the change be undone, and what would undoing it cost? Revert
    the commit.
  • Which users or callers does it affect, and how? Readers of the AI
    disclosure, and agents, whose permitted role in these four parts
    widens to first drafts reviewed line by line.
  • Does it change any numerical result, and which? No.
  • Does it change any stored artifact, file name, or file format? No.

Notes for review

The role wording is the file's existing Supervised description, not new
wording.

Assisted-by: Claude Code, claude-opus-5-5 (full implementation)
Checks-run: flake8 — exit 0; mypy — no issues in 43 files
Checks-run: full tests without private data — 2703 passed, 61 skipped

- README.md, "AI assistance": the polyphys/analyze/, manage/, simulate/,
  and probe/ rows become Supervised, their review cell "maintainer
  review of every line", as the projects/ row says; "Tiers last
  reviewed" becomes 2026-11-08; the table is realigned.
- AGENTS.md, "Where you may write": the same four rows become
  Supervised, with the role the file already gives a Supervised path.
- CHANGELOG.md: the Changed line for #269.

Why: the maintainer, on 2026-11-08, chose Supervised for these four
parts, whose 1.0 modules an AI agent drafted against the maintainer's
acceptance criteria and the maintainer read line by line (#269).

Assisted-by: Claude Code, claude-opus-5-5 (full implementation)
Checks-run: python -m flake8 polyphys projects — exit 0
Checks-run: python -m mypy polyphys/analyze polyphys/manage polyphys/probe polyphys/simulate projects — no issues in 43 files
Checks-run: full test command without POLYPHYS_DATA_DIR — 2703 passed, 61 skipped
@amirhs1 amirhs1 added type:docs Type: docs area:guide Area: guide area:agents Area: agents labels Nov 9, 2026
@codecov

codecov Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.95%. Comparing base (102e706) to head (0b1040b).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #270   +/-   ##
=======================================
  Coverage   99.95%   99.95%           
=======================================
  Files          62       62           
  Lines       10948    10948           
=======================================
  Hits        10943    10943           
  Misses          5        5           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@amirhs1
amirhs1 marked this pull request as ready for review November 9, 2026 02:05
@amirhs1
amirhs1 merged commit ae7b119 into main Nov 9, 2026
13 checks passed
@amirhs1
amirhs1 deleted the docs/supervised-tiers branch November 9, 2026 02:05
@amirhs1
amirhs1 restored the docs/supervised-tiers branch November 9, 2026 02:05
amirhs1 added a commit that referenced this pull request Nov 9, 2026
…ed (#271)

<!-- Title: as CONTRIBUTING.md, "Names", sets it. -->

## Summary

The AI tier tables now rate every part of the repository as Supervised.
#270 did this for `analyze/`, `manage/`, `simulate/`, and `probe/`; this
pull request does the same for `viz/`, the tests with the workflows and
`pyproject.toml`, and `docs/`, which an AI agent also drafted and the
maintainer read line by line. The maintainer chose Supervised for these
on 2026-11-08, after #270 merged.

## Related issues

Refs #269

## Problem

After #270, `README.md`, "AI assistance", and `AGENTS.md`, "Where you
may write", still rated `polyphys/viz/`, `polyphys/tests/` with
`.github/workflows/` and `pyproject.toml`, and `docs/` as Instrumented
("not first drafts of core logic"), which disagreed with how they were
written.

## What changed

- `README.md:267-274`: the three rows say Supervised and "maintainer
  review of every line"; the table's last column is realigned. The
  definitions of Instrumented and Delegated stay, as the scheme a future
  part can take.
- `AGENTS.md:161-165`: the three rows, with the file's existing
Supervised
role: "Draft against acceptance criteria the maintainer set; every line
  is read."
- `CHANGELOG.md`: the #269 line now covers every part.

## Checks run

- `python -m pytest README.md` → 1 passed
- On the parent commit `0b1040b` (#270), the full gate: flake8 exit 0;
  mypy, no issues in 43 files; full tests without private data, 2703
  passed, 61 skipped. This commit changes only Markdown tables and one
  changelog line.

Not verified: the full gate on this commit; CI runs it.

- [ ] `python -m flake8 polyphys projects`: no Python changed; CI runs
it
- [ ] `python -m mypy polyphys/analyze polyphys/manage polyphys/probe
polyphys/simulate projects`: no Python changed; CI runs it
- [ ] `python -m pytest polyphys README.md projects --cov=polyphys
--cov-report=term-missing --cov-report=xml --doctest-modules
--doctest-glob='README.md'`: the README doctest ran locally; CI runs the
rest
- [ ] `python -m build` if packaging metadata, package data, or package
layout changed: not changed
- [ ] `python -m sphinx -W -b html docs/source docs/_build` if
`docs/source/` changed: not changed
- [x] `CHANGELOG.md` has an entry under `[Unreleased]`, or this pull
request needs none (`CONTRIBUTING.md`, "Changelog")

## Scientific correctness

- [x] Measurement and statistics behavior is unchanged, or the change is
explained above with how it was validated
- [x] Units, numerical fixtures, and domain assumptions are preserved or
explained
- [x] Parser lineage and organizer vocabulary are unchanged, or matching
parser tests/docs were updated

Documentation of AI use only.

## Decisions and risks

- How would the change be undone, and what would undoing it cost? Revert
  the commit.
- Which users or callers does it affect, and how? Readers of the AI
  disclosure, and agents, whose permitted role in these parts widens to
  first drafts reviewed line by line.
- Does it change any numerical result, and which? No.
- Does it change any stored artifact, file name, or file format? No.

## Notes for review

The branch starts at #270's commit `0b1040b`, which is already in
`main`,
so the diff is this commit alone.

Assisted-by: Claude Code, claude-opus-5-5 (full implementation)
Checks-run: pytest README.md — 1 passed
@amirhs1
amirhs1 deleted the docs/supervised-tiers branch November 9, 2026 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:agents Area: agents area:guide Area: guide type:docs Type: docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[agents] Rate analyze, manage, simulate, and probe as Supervised

1 participant