Skip to content

docs: document the normalized level-one contract - #176

Merged
SkyeAv merged 1 commit into
stronger-l1/perf-testsfrom
stronger-l1/docs-changelog
Sep 15, 2026
Merged

SkyeAv merged 1 commit into
stronger-l1/perf-testsfrom
stronger-l1/docs-changelog

Conversation

@SkyeAv

@SkyeAv SkyeAv commented Sep 15, 2026

Copy link
Copy Markdown
Owner

Locks the normalized level-one contract in place: a shared golden fixture consumed by both languages, API docs describing the v6 semantics, and the BREAKING changelog entry.

Golden equivalence

  • rust/tests/fixtures/nlp_golden.tsv: representative vectors (reorder, inflections, dedupe, whitespace, digits, punctuation, Unicode lowercase, empty via an explicit @EMPTY encoding that keeps git diff --check clean) consumed by BOTH rust/tests/nlp_golden.rs and a tests/test_nlp.py golden test through the compiled level_one path — the two sides can never silently acquire different normalization contracts.

Docs

  • docs/api/fullmap.md, docs/api/lib.md: document the level-one semantics precisely (clean/Unicode lowercase, whitespace tokenization, Porter2 stemming of all-ASCII-alphabetic tokens only, digit/punctuation pass-through, dedupe + byte-wise sort + single-space join, null preservation), the schema-v6 rebuild requirement, and the raw-exact-then-normalized preferred-name ranking; stale "lowercase + strip" passages replaced.
  • docs/fullmap.md, docs/cli.md: schema references updated in the migration PR are kept consistent.

CHANGELOG

  • ## Unreleased → Breaking Changes: level-one keys now defined by normalized terms; schema-v5 databases rejected, rebuild required; preferred-name ranking compares normalized forms.

Testing

  • cargo test --manifest-path rust/Cargo.toml --test nlp_golden1 passed; uv run pytest tests/test_nlp.py -k golden -n 0 -q1 passed, 16 deselected; full NLP suite → 17 passed
  • Full gate at stack top: make check → exit 0 (ruff lint/format, full-repo pyright 0 errors, pytest, cargo test, clippy -D warnings); uv run pytest1352 passed, 43 skipped, 0 failed
  • Independent final audit: APPROVE — no blockers, no should-fix, no nits

@SkyeAv
SkyeAv added this pull request to stack #177 September 15, 2026 17:41
@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 1d1d4e57-5417-4c6b-947a-a2741d84b85a


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@SkyeAv SkyeAv changed the title docs: align fullmap API text with normalized level one docs: document the normalized level-one contract Sep 15, 2026
@SkyeAv
SkyeAv marked this pull request as ready for review September 15, 2026 17:42
@SkyeAv
SkyeAv removed this pull request from stack #177 September 15, 2026 17:50
@SkyeAv
SkyeAv added this pull request to stack #179 September 15, 2026 17:51
- update resolve input and ranking descriptions for canonical v6 keys
- replace stale lowercase-and-strip example comments with token canonicalization
- distinguish raw exact preferred-name matching from normalized fallback ranking

Verified: docs source-of-truth/examples 156 passed; focused NLP/fullmap suite
90 passed; ruff, format, cargo fmt, and diff checks clean.
@SkyeAv
SkyeAv force-pushed the stronger-l1/docs-changelog branch from 87fd408 to 743082c Compare September 15, 2026 17:53
@SkyeAv
SkyeAv merged commit d2a9a01 into main Sep 15, 2026
5 of 9 checks passed
SkyeAv added a commit that referenced this pull request Sep 15, 2026
Cut 19.0.0 and bump the package version in pyproject.toml, CITATION.cff,
and uv.lock.

Major: five breaking changes ship. The `tablassert` console command now
requires the optional `[cli]` extra, since `cyclopts` and `rich` left the
base install (#187). Level-one normalization redefines fullmap keys as
cleaned Unicode-lowercase, Porter2-normalized, byte-ordered token sets and
moves the database to schema v6, so every schema-v5 fullmap is rejected and
must be rebuilt (#171, #172, #174, #175, #176). `build-fullmap --aria2c`
is gone -- aria2c is used automatically whenever the `[aria2]` extra is
installed (#178) -- and `--taxon-allowlist` is gone because the built-in
top-100 experimental-taxon allowlist now applies to every build, guarding
both reuse paths by `META.taxon_allowlist` identity (#153). Logging now
requires the `[log]` extra and is fully disabled without it (#152).

Features: `tablassert.net` is a new stdlib-only transient/permanent
classification and retry seam shared by the agent and the BABEL downloader
(#163, #164), with one bounded jittered retry layer across the inner agent,
reflexion, and judge (#167) and machine-readable `error_code` values on
skipped checkpoint records (#166). `build-kg` gained an automatic ephemeral
shared-prefix TCode cache keyed by content-addressed XXH64 op digests
(#155-#159, #161). The `--distill` corpus became schema-uniform v2 with a
sibling `outcomes.ndjson`, a deterministic `RewardConfig`-tunable reward,
and the new zero-dependency `tablassert distill-weigh` command (#180-#183).
`CLASS_FIELD_OVERRIDES` grants the DAKP sparse qualifier stack on the pinned
association classes (#188).

Fixes: `distill-export` partitions its corpus by content and unions the
schema across record files, so a mixed v1/v2 directory no longer CastErrors
or silently stringifies a column (#184); BABEL retry warnings survive the
loguru sink; PMC downloads are idempotent, atomic, and bounded-parallel
(#165); reflexion and judge prompts are hard-bounded (#168).

Changelog:
- versioned the Unreleased section as 19.0.0 - 2026-09-15
- merged three duplicate `### Added` blocks into one
- moved the two `BREAKING:` entries from `### Changed` into
  `### Breaking Changes` and added a `**Migration:**` note to all five
- added PR links to all 17 entries, which carried none
- added the missing entries: the distill v2 corpus/reward/distill-weigh
  stack (#180-#183), the distill-export schema-drift fix (#184), the
  TCode run-cache detail (#155-#161), and the README badge removal (#154)

Docs: none needed here. Every shipped doc change landed with its own PR,
and the docs source-of-truth gate passes against the bumped tree.

Testing:
- make check -> exit 0
- uv run ruff check . -> All checks passed!
- uv run pyright -> 0 errors, 0 warnings, 0 informations
- uv run pytest -> 1622 passed, 52 skipped
- cargo test --manifest-path rust/Cargo.toml -> 156 passed, 0 failed
- cargo clippy --all-targets -- -D warnings -> clean
- uv lock --check -> resolved 169 packages, lock current
- uv run mkdocs build --strict -> exit 0
- docs SSOT + CLI coverage after the changelog edit -> 204 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.

1 participant