Skip to content

README: audit fields, certified-threshold scope, base-model defaults, known limits - #12

Merged
imxinchengyou merged 1 commit into
mainfrom
readme-refresh
Nov 8, 2026
Merged

imxinchengyou merged 1 commit into
mainfrom
readme-refresh

Conversation

@imxinchengyou

Copy link
Copy Markdown
Owner

Brings the README in line with the service and the website (US #151–#157). README only, no code change.

  • VerifyResult table: adds audit, verification_id and decision_rule (all already on the dataclass). audit matters most: an audited approval comes back approved=False and should be reported.
  • Quickstart: the hosted example now reports an audited call with verification_id, like the LocalVerifier example already did.
  • Certified thresholds bullet: informational (verify() doesn't apply it), holds while traffic resembles calibration data, covers only hits sent to verify(); ACI is the opt-in one that changes decisions.
  • Local Health Check: says the CLI defaults to ms_marco while hosted fine-tunes default to nli, and to pass --base-model nli to compare (it used to say the numbers stay comparable). CLI default unchanged.
  • Known limits: MS MARCO training-data terms for the shared stock model; fine-tunes start from the NLI base.
  • Links: research repo described as four papers with code and raw results; TypeScript users pointed to docs#typescript.

PyPI still shows the 0.7.0 README (before #9/#10); it updates only with a new release.

…rule; quickstart reports audits; certified thresholds are informational, stable-traffic-only and cover only verified hits; healthcheck vs hosted base-model defaults; MS MARCO terms in known limits; TypeScript pointer
@imxinchengyou
imxinchengyou merged commit a2164b3 into main Nov 8, 2026
7 checks passed
@imxinchengyou
imxinchengyou deleted the readme-refresh branch November 8, 2026 05:38
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