Skip to content

Commit eba86db

Browse files
committed
docs(readme): surface v0.3 (pip install, MCP, OSCAL/SARIF, Action, benchmark)
Add an Install + verify section and the honest benchmark headline (7/7 benign allowed vs models over-refusing 2-4/7; 15/17 high-stakes intercepted, the 2 allows FERPA-permitted). Bump test count to 185; add DeepSeek to the models line.
1 parent d382d53 commit eba86db

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,28 @@ A proof-of-concept for turning institutional-policy and regulatory requirements
77
- **FERPA** — 34 CFR Part 99, Subpart D (education-record disclosure)
88
- **Title IV** — 34 CFR Part 668 subset: Satisfactory Academic Progress (§ 668.34) + student eligibility (§ 668.32)
99

10-
**37 machine-readable rules across 8 sections**, each pinned to verbatim CFR text by a faithfulness gate; a deterministic engine that emits a typed `GuardrailDecision` with a **risk tier** and a **human-gate** flag; tamper-evident **hash-chained decision provenance**; and a **22-scenario golden corpus** with a published coverage matrix. Apache-2.0, Python 3.12+, `uv`-managed. 159 tests; ruff + mypy-strict clean.
10+
**37 machine-readable rules across 8 sections**, each pinned to verbatim CFR text by a faithfulness gate; a deterministic engine that emits a typed `GuardrailDecision` with a **risk tier** and a **human-gate** flag; tamper-evident **hash-chained decision provenance**; and a **22-scenario golden corpus** with a published coverage matrix. Apache-2.0, Python 3.12+, `uv`-managed. 185 tests; ruff + mypy-strict clean.
1111

1212
> This is a proof-of-concept, not a compliance product and not legal advice. It encodes *selected* provisions with verbatim traceability for the rules included, and routes high-stakes determinations to a human. See **[Limitations](#limitations)**.
1313
1414
---
1515

16+
## Install + verify in a minute
17+
18+
```bash
19+
pip install regrails
20+
21+
regrails check faithfulness # 37/37 rules verbatim-faithful to the bundled CFR text
22+
regrails decide -q "I defaulted; am I eligible for aid?" --topic aid_status --aid-determination --in-default
23+
regrails export oscal # OSCAL 1.1.2-shaped catalog of the 37 rules
24+
regrails mcp serve # MCP server: consult_guardrail / list_rules / check_faithfulness
25+
regrails bench report # the held-out with/without-guardrail pilot
26+
```
27+
28+
Beyond the engine, v0.3 adds: an **MCP server** (the guardrail as an agent tool — `consult_guardrail`, engine-only, so an AI agent consults it *before* answering); **signed PyPI** releases (PEP 740 + SLSA attestations); **OSCAL** + **SARIF** export; a reusable **[GitHub Action](docs/action/)** that fails a CI job on `block` / `escalate_human_review`; a **[methodology + limitations doc](docs/METHODOLOGY.md)** (scope boundary, label provenance, the 6 coverage gaps listed by ID); and a held-out **[benchmark](docs/EVAL.md)** (24 independently-authored scenarios × GPT‑5.5 / Gemini 3.1 Pro / Grok 4.3 / DeepSeek, labeled by an independent Claude judge): the guardrail allows **7/7** benign asks where the unguarded models over-refuse 2–4/7, and intercepts **15/17** high-stakes — the 2 it allows are FERPA-permitted (emergency disclosure, parental inspection), surfaced honestly rather than hidden.
29+
30+
---
31+
1632
## The idea: what AI may automate vs. what needs a human
1733

1834
Every decision is tagged with a **risk tier** derived from reversibility and blast radius:
@@ -108,7 +124,7 @@ uv run python -m regrails.demo --all
108124
uv run python -m regrails.demo --replay demo/recorded-runs/
109125
uv run regrails audit verify demo/recorded-runs/decisions.chain.jsonl
110126

111-
uv run pytest -q # 159 tests
127+
uv run pytest -q # 185 tests
112128
```
113129

114130
---
@@ -144,7 +160,7 @@ regrails/
144160
│ ├── llm.py # advisor renderer (OpenRouter; retry + fallback)
145161
│ ├── coverage.py · report.py · demo.py
146162
│ └── cli/ # regrails {check, encode, decide, coverage, audit, report, research}
147-
└── tests/ # 159 tests incl. golden corpus + tamper-detection
163+
└── tests/ # 185 tests incl. golden corpus + tamper-detection
148164
```
149165

150166
---
@@ -175,4 +191,4 @@ Apache-2.0. See [LICENSE](LICENSE).
175191

176192
This project was developed alongside AI platforms.
177193

178-
Models used: Claude Opus 4.8, GPT-5.5, Gemini 3.1 Pro, Grok 4.3, Perplexity Sonar (Deep Research + Pro)
194+
Models used: Claude Opus 4.8, GPT-5.5, Gemini 3.1 Pro, Grok 4.3, DeepSeek, Perplexity Sonar (Deep Research + Pro)

0 commit comments

Comments
 (0)