ai-mrg 0.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ai_mrg-0.3.0/.gitignore +36 -0
- ai_mrg-0.3.0/CHANGELOG.md +85 -0
- ai_mrg-0.3.0/LICENSE +175 -0
- ai_mrg-0.3.0/NOTICE +7 -0
- ai_mrg-0.3.0/PKG-INFO +156 -0
- ai_mrg-0.3.0/README.md +82 -0
- ai_mrg-0.3.0/docs/ARCHITECTURE.md +343 -0
- ai_mrg-0.3.0/docs/REGULATORY_MAP.md +60 -0
- ai_mrg-0.3.0/docs/ROADMAP.md +115 -0
- ai_mrg-0.3.0/docs/adr/0001-license-apache-2.md +15 -0
- ai_mrg-0.3.0/docs/adr/0002-controls-as-data.md +15 -0
- ai_mrg-0.3.0/docs/adr/0003-local-first.md +14 -0
- ai_mrg-0.3.0/docs/adr/0004-streamlit-first-dashboard.md +14 -0
- ai_mrg-0.3.0/docs/adr/0005-sqlite-stdlib-storage.md +15 -0
- ai_mrg-0.3.0/docs/adr/0006-postgres-and-api-tokens.md +33 -0
- ai_mrg-0.3.0/docs/ai-systems.md +91 -0
- ai_mrg-0.3.0/docs/api.md +118 -0
- ai_mrg-0.3.0/docs/checks.md +152 -0
- ai_mrg-0.3.0/docs/dashboard.md +40 -0
- ai_mrg-0.3.0/docs/deployment.md +70 -0
- ai_mrg-0.3.0/docs/exam-packages.md +46 -0
- ai_mrg-0.3.0/docs/getting-started.md +187 -0
- ai_mrg-0.3.0/docs/img/dashboard-controls.png +0 -0
- ai_mrg-0.3.0/docs/img/dashboard-inventory.png +0 -0
- ai_mrg-0.3.0/docs/img/dashboard-lifecycle.png +0 -0
- ai_mrg-0.3.0/docs/img/dashboard-monitoring.png +0 -0
- ai_mrg-0.3.0/docs/index.md +24 -0
- ai_mrg-0.3.0/docs/mlflow.md +65 -0
- ai_mrg-0.3.0/docs/packs.md +74 -0
- ai_mrg-0.3.0/docs/workflow.md +78 -0
- ai_mrg-0.3.0/examples/credit-scorecard/README.md +53 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/ai_systems.yaml +90 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/consumer_protection.yaml +128 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/development.yaml +46 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/governance.yaml +40 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/inventory.yaml +41 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/monitoring.yaml +56 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/third_party.yaml +56 -0
- ai_mrg-0.3.0/packs/fin-us-banking/controls/validation.yaml +71 -0
- ai_mrg-0.3.0/packs/fin-us-banking/pack.yaml +15 -0
- ai_mrg-0.3.0/packs/fin-us-banking/sources.yaml +86 -0
- ai_mrg-0.3.0/packs/fin-us-banking/templates/adverse_action_reasons.md.j2 +53 -0
- ai_mrg-0.3.0/packs/fin-us-banking/templates/ai_system_record.md.j2 +116 -0
- ai_mrg-0.3.0/packs/fin-us-banking/templates/colorado_admt_notices.md.j2 +48 -0
- ai_mrg-0.3.0/packs/fin-us-banking/templates/fair_lending_report.md.j2 +71 -0
- ai_mrg-0.3.0/packs/fin-us-banking/templates/inventory_report.md.j2 +60 -0
- ai_mrg-0.3.0/packs/fin-us-banking/templates/validation_report.md.j2 +153 -0
- ai_mrg-0.3.0/packs/fin-us-banking/templates/vendor_assessment.md.j2 +46 -0
- ai_mrg-0.3.0/packs/fin-us-banking/thresholds/default.yaml +52 -0
- ai_mrg-0.3.0/packs/fin-us-banking/tiering/default.yaml +46 -0
- ai_mrg-0.3.0/pyproject.toml +118 -0
- ai_mrg-0.3.0/schemas/asset-record.schema.json +302 -0
- ai_mrg-0.3.0/schemas/evidence-item.schema.json +145 -0
- ai_mrg-0.3.0/schemas/finding.schema.json +118 -0
- ai_mrg-0.3.0/schemas/pack-controls.schema.json +248 -0
- ai_mrg-0.3.0/schemas/pack-manifest.schema.json +72 -0
- ai_mrg-0.3.0/schemas/pack-sources.schema.json +104 -0
- ai_mrg-0.3.0/schemas/pack-thresholds.schema.json +67 -0
- ai_mrg-0.3.0/schemas/pack-tiering-profile.schema.json +112 -0
- ai_mrg-0.3.0/schemas/risk-assessment.schema.json +103 -0
- ai_mrg-0.3.0/src/aimrg/__init__.py +11 -0
- ai_mrg-0.3.0/src/aimrg/adverse_action.py +124 -0
- ai_mrg-0.3.0/src/aimrg/api.py +685 -0
- ai_mrg-0.3.0/src/aimrg/checks/__init__.py +34 -0
- ai_mrg-0.3.0/src/aimrg/checks/adverse_action_checks.py +194 -0
- ai_mrg-0.3.0/src/aimrg/checks/base.py +205 -0
- ai_mrg-0.3.0/src/aimrg/checks/builtin.py +279 -0
- ai_mrg-0.3.0/src/aimrg/checks/fairness.py +265 -0
- ai_mrg-0.3.0/src/aimrg/checks/genai.py +316 -0
- ai_mrg-0.3.0/src/aimrg/checks/metrics.py +105 -0
- ai_mrg-0.3.0/src/aimrg/checks/runner.py +111 -0
- ai_mrg-0.3.0/src/aimrg/cli.py +1439 -0
- ai_mrg-0.3.0/src/aimrg/core/__init__.py +39 -0
- ai_mrg-0.3.0/src/aimrg/core/classify.py +82 -0
- ai_mrg-0.3.0/src/aimrg/core/models.py +327 -0
- ai_mrg-0.3.0/src/aimrg/dashboard/__init__.py +7 -0
- ai_mrg-0.3.0/src/aimrg/dashboard/app.py +334 -0
- ai_mrg-0.3.0/src/aimrg/dashboard/client.py +128 -0
- ai_mrg-0.3.0/src/aimrg/dashboard/views.py +167 -0
- ai_mrg-0.3.0/src/aimrg/datasets.py +247 -0
- ai_mrg-0.3.0/src/aimrg/export.py +226 -0
- ai_mrg-0.3.0/src/aimrg/findings.py +58 -0
- ai_mrg-0.3.0/src/aimrg/integrations/__init__.py +1 -0
- ai_mrg-0.3.0/src/aimrg/integrations/mlflow.py +231 -0
- ai_mrg-0.3.0/src/aimrg/packs/__init__.py +30 -0
- ai_mrg-0.3.0/src/aimrg/packs/expr.py +155 -0
- ai_mrg-0.3.0/src/aimrg/packs/loader.py +207 -0
- ai_mrg-0.3.0/src/aimrg/packs/models.py +277 -0
- ai_mrg-0.3.0/src/aimrg/packs/resolver.py +122 -0
- ai_mrg-0.3.0/src/aimrg/py.typed +0 -0
- ai_mrg-0.3.0/src/aimrg/registry/__init__.py +6 -0
- ai_mrg-0.3.0/src/aimrg/registry/accounts.py +142 -0
- ai_mrg-0.3.0/src/aimrg/registry/backends.py +249 -0
- ai_mrg-0.3.0/src/aimrg/registry/importer.py +113 -0
- ai_mrg-0.3.0/src/aimrg/registry/store.py +593 -0
- ai_mrg-0.3.0/src/aimrg/reports/__init__.py +12 -0
- ai_mrg-0.3.0/src/aimrg/reports/docx.py +110 -0
- ai_mrg-0.3.0/src/aimrg/reports/render.py +208 -0
- ai_mrg-0.3.0/src/aimrg/schema.py +66 -0
- ai_mrg-0.3.0/src/aimrg/tiering.py +72 -0
- ai_mrg-0.3.0/src/aimrg/workflow.py +241 -0
- ai_mrg-0.3.0/tests/conftest.py +112 -0
- ai_mrg-0.3.0/tests/test_accounts_webhooks.py +182 -0
- ai_mrg-0.3.0/tests/test_api.py +315 -0
- ai_mrg-0.3.0/tests/test_checks.py +277 -0
- ai_mrg-0.3.0/tests/test_cli_and_schema.py +88 -0
- ai_mrg-0.3.0/tests/test_cli_workflow.py +475 -0
- ai_mrg-0.3.0/tests/test_core_models.py +176 -0
- ai_mrg-0.3.0/tests/test_dashboard.py +198 -0
- ai_mrg-0.3.0/tests/test_expr.py +103 -0
- ai_mrg-0.3.0/tests/test_fairness_and_reasons.py +287 -0
- ai_mrg-0.3.0/tests/test_genai_colorado_export.py +346 -0
- ai_mrg-0.3.0/tests/test_mlflow.py +148 -0
- ai_mrg-0.3.0/tests/test_packs.py +249 -0
- ai_mrg-0.3.0/tests/test_registry.py +261 -0
- ai_mrg-0.3.0/tests/test_reports_and_example.py +104 -0
- ai_mrg-0.3.0/tests/test_tiering_and_resolver.py +159 -0
- ai_mrg-0.3.0/tests/test_workflow.py +300 -0
ai_mrg-0.3.0/.gitignore
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*.egg-info/
|
|
5
|
+
.eggs/
|
|
6
|
+
build/
|
|
7
|
+
dist/
|
|
8
|
+
.venv/
|
|
9
|
+
venv/
|
|
10
|
+
|
|
11
|
+
# Tooling caches
|
|
12
|
+
.pytest_cache/
|
|
13
|
+
.mypy_cache/
|
|
14
|
+
.ruff_cache/
|
|
15
|
+
.coverage
|
|
16
|
+
coverage.xml
|
|
17
|
+
htmlcov/
|
|
18
|
+
|
|
19
|
+
# Docs build
|
|
20
|
+
site/
|
|
21
|
+
|
|
22
|
+
# AI-MRG local data (never commit governance evidence)
|
|
23
|
+
*.db
|
|
24
|
+
*.sqlite
|
|
25
|
+
.aimrg/
|
|
26
|
+
evidence/
|
|
27
|
+
|
|
28
|
+
# Secrets
|
|
29
|
+
.env
|
|
30
|
+
.env.*
|
|
31
|
+
|
|
32
|
+
# OS / editors
|
|
33
|
+
.DS_Store
|
|
34
|
+
Thumbs.db
|
|
35
|
+
.idea/
|
|
36
|
+
.vscode/
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes are documented here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses [Semantic Versioning](https://semver.org/).
|
|
4
|
+
|
|
5
|
+
Packs are versioned separately; their changes are listed under **Packs**.
|
|
6
|
+
|
|
7
|
+
## [Unreleased]
|
|
8
|
+
|
|
9
|
+
## [0.3.0] — Phase 3
|
|
10
|
+
|
|
11
|
+
### Added (Phase 3b)
|
|
12
|
+
- **Dashboard** (`ai-mrg[dashboard]`, `aimrg dashboard`): inventory, asset controls/evidence/findings/lifecycle, findings aging, monitoring trends, report center and examination packages. Works only through the REST API, so roles and approval rules apply. Deep links via `?page=…&asset=…`.
|
|
13
|
+
- **MLflow integration** (`ai-mrg[mlflow]`, `aimrg mlflow import|sync|record`): import registered models into the inventory, write governance tags and the main report back to MLflow, and record runs as evidence.
|
|
14
|
+
- **Docker Compose**: `Dockerfile`, `docker-compose.yml` (PostgreSQL, API, dashboard) with idempotent bootstrap; smoke-tested in CI.
|
|
15
|
+
- **Release workflow** for PyPI trusted publishing (`release.yml`, `RELEASING.md`).
|
|
16
|
+
- API: `GET /assets/{ref}/check-results`, `GET /templates`.
|
|
17
|
+
- `aimrg init --if-missing`; assets record `external_refs`.
|
|
18
|
+
- The example runs two monitoring cycles (one clean, one with drift).
|
|
19
|
+
|
|
20
|
+
### Added (Phase 3a)
|
|
21
|
+
- **AI-system track checks**: `genai.evaluation_suite` (pass rates per category, required categories, category-specific thresholds, NIST AI 600-1 mapping), `genai.red_team_log`, `genai.agent_permission_audit`.
|
|
22
|
+
- `sensitivity.alternative_assumptions`; every check referenced by `fin-us-banking` is now implemented.
|
|
23
|
+
- **AI-system governance record** template with the twelve NIST AI 600-1 risks.
|
|
24
|
+
- **Colorado SB 26-189**: controls FIN-CPR-005 to FIN-CPR-008 (pre-use notice, 30-day adverse-outcome disclosure, data correction and human review, record retention) and FIN-TPM-004 (developer documentation); `colorado_admt_notices` draft template.
|
|
25
|
+
- **Examination packages**: `aimrg export create|verify`, `GET /export`; records, evidence, artifacts, reports, pack snapshot and `SHA256SUMS`.
|
|
26
|
+
- `aimrg.datasets.synthetic_genai_evidence`; the example now includes an agentic assistant and an examination package.
|
|
27
|
+
|
|
28
|
+
### Packs
|
|
29
|
+
- `fin-us-banking`: new Colorado and AI-system content above; thresholds `genai_pass_rate` and `genai_pass_rate.prompt_injection` (illustrative).
|
|
30
|
+
|
|
31
|
+
## [0.2.0] — Phase 2
|
|
32
|
+
|
|
33
|
+
### Added (Phase 2b)
|
|
34
|
+
- **PostgreSQL backend** (`pip install "ai-mrg[postgres]"`): `aimrg --db postgresql://... init --artifacts-dir ...`. Append-only triggers on evidence and lifecycle events in both backends; the full test suite runs against both (ADR-0006).
|
|
35
|
+
- **REST API** (`pip install "ai-mrg[api]"`, `aimrg serve`): assets, classification, tiering, plans, evidence uploads, check runs with CSV uploads, findings, lifecycle transitions, reports (Markdown/Word) and audit verification. Role-based access (viewer, developer, validator, approver, auditor, admin); the authenticated user is always the recorded actor and, for approvals, the approver.
|
|
36
|
+
- **Users and tokens**: `aimrg user add|list|disable|rotate-token`; tokens stored as SHA-256 hashes.
|
|
37
|
+
- **Webhooks**: `aimrg webhook add|list|test|remove`; HMAC-SHA256-signed notifications for `finding.opened`, `finding.resolved`, `check.failed` and `lifecycle.transition`; opt-in and non-blocking.
|
|
38
|
+
- `Registry.subscribe()` for in-process notifications.
|
|
39
|
+
|
|
40
|
+
### Changed
|
|
41
|
+
- Registry schema version 3 (`users`, `webhooks`, ordered lifecycle events); older SQLite registries migrate on open.
|
|
42
|
+
- `--db` accepts a PostgreSQL URL; `Registry.path` replaced by `Registry.location`.
|
|
43
|
+
- Artifact URIs that try to leave the artifacts directory are rejected.
|
|
44
|
+
|
|
45
|
+
### Added (Phase 2a)
|
|
46
|
+
- **Fair-lending checks**: `fairness.adverse_impact_ratio` (with two-proportion p-values) and `fairness.standardized_mean_difference`, using group labels or proxy membership probabilities.
|
|
47
|
+
- **Adverse-action reasons** (`aimrg.adverse_action`): reason maps, reason derivation from per-applicant attributions, and checks `adverse_action.reason_mapping` and `adverse_action.reason_specificity`; `aimrg reasons derive`.
|
|
48
|
+
- **Lifecycle workflow** (`aimrg.workflow`): gated transitions, independent-approver rule, `approved_with_limits`, approval evidence written automatically; `aimrg transition` and `aimrg status`. Lifecycle events are append-only.
|
|
49
|
+
- **Findings aging**: default due dates by severity, `aimrg finding aging`, overdue section in the inventory report.
|
|
50
|
+
- Report templates: `fair_lending_report`, `adverse_action_reasons`, `vendor_assessment`; lifecycle history in the validation report.
|
|
51
|
+
- `aimrg check run --param key=value`.
|
|
52
|
+
- `aimrg.datasets.synthetic_lending_decisions`; the example now runs the full lifecycle.
|
|
53
|
+
|
|
54
|
+
### Changed
|
|
55
|
+
- Registry schema version 2 (adds the `events` table); version-1 registries are migrated automatically on open.
|
|
56
|
+
- `Registry.save()` no longer changes lifecycle status; use the workflow. `Registry.set_status()` was removed.
|
|
57
|
+
|
|
58
|
+
## [0.1.0] — Phase 1
|
|
59
|
+
|
|
60
|
+
### Added
|
|
61
|
+
- **Registry** (`aimrg.registry`): SQLite-backed store for assets, evidence and findings; content-addressed artifact store; append-only evidence enforced by triggers and a per-asset hash chain; `verify()` for integrity audits (ADR-0005).
|
|
62
|
+
- **Bulk import** of inventories from CSV or YAML, all-or-nothing, with dependency ordering and cycle detection.
|
|
63
|
+
- **Classification wizard** and **risk tiering** with approved overrides and aggregate-risk flags from the dependency graph.
|
|
64
|
+
- **Control resolver**: required controls per asset and stage, with evidence coverage (`missing`, `partial`, `failing`, `complete`).
|
|
65
|
+
- **Checks** (`aimrg.checks`): `data.quality_summary`, `data.representativeness`, `performance.out_of_sample`, `performance.out_of_time`, `performance.discrimination_drift`, `stability.population_stability`, `outcomes.backtest`; plugin entry point `aimrg.checks`; runner that records results as evidence and opens findings on failure.
|
|
66
|
+
- **Reports**: validation report and inventory report templates (Markdown), with Word export (`ai-mrg[docx]`).
|
|
67
|
+
- **CLI**: `init`, `register`, `import`, `list`, `show`, `classify`, `tier`, `plan`, `check list|run`, `evidence add|list`, `finding list|open|close|accept`, `report list|render`, `audit verify`.
|
|
68
|
+
- `aimrg.datasets.synthetic_credit_portfolio` and an end-to-end example in `examples/credit-scorecard/`.
|
|
69
|
+
|
|
70
|
+
### Changed
|
|
71
|
+
- Control `checks[].thresholds` now hold full threshold definitions (`warn`, `fail`, `direction`).
|
|
72
|
+
- Evidence items record `check_id` and `outcome` for automated checks.
|
|
73
|
+
|
|
74
|
+
### Packs
|
|
75
|
+
- `fin-us-banking` 0.1.0-dev: added `backtest_relative_error` threshold and report templates; FIN-VAL-003 threshold override uses the new format.
|
|
76
|
+
|
|
77
|
+
## [0.0.1] — Phase 0
|
|
78
|
+
|
|
79
|
+
### Added
|
|
80
|
+
- Phase 0 foundations: package skeleton, domain models (asset, classification, risk assessment, evidence, finding), JSON Schemas, a safe expression language for control applicability, pack loader and validator, and the `aimrg` CLI (`pack list`, `pack validate`, `schema export`).
|
|
81
|
+
- CI (lint, type-check, test on Python 3.11–3.13) and a documentation site.
|
|
82
|
+
- Architecture, regulatory map, roadmap and ADRs 0001–0004.
|
|
83
|
+
|
|
84
|
+
### Packs
|
|
85
|
+
- `fin-us-banking` 0.1.0-dev: draft seed controls, sources register, default tiering profile and thresholds. **Not yet reviewed by practitioners.**
|
ai_mrg-0.3.0/LICENSE
ADDED
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
ai_mrg-0.3.0/NOTICE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
AI-MRG Framework
|
|
2
|
+
Copyright 2026 The AI-MRG Framework contributors
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
5
|
+
|
|
6
|
+
AI-MRG provides governance tooling and reference content. It is not legal
|
|
7
|
+
advice, and its use does not by itself establish regulatory compliance.
|
ai_mrg-0.3.0/PKG-INFO
ADDED
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: ai-mrg
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Open-source, full-lifecycle AI and model risk governance toolkit for U.S. regulated industries.
|
|
5
|
+
Project-URL: Homepage, https://github.com/abiroland/ai-mrg-framework
|
|
6
|
+
Project-URL: Documentation, https://abiroland.github.io/ai-mrg-framework/
|
|
7
|
+
Project-URL: Issues, https://github.com/abiroland/ai-mrg-framework/issues
|
|
8
|
+
Project-URL: Changelog, https://github.com/abiroland/ai-mrg-framework/blob/main/CHANGELOG.md
|
|
9
|
+
Author: AI-MRG Framework contributors
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
License-File: NOTICE
|
|
13
|
+
Keywords: AI governance,NIST AI RMF,SR 26-2,adverse action,fair lending,model risk management
|
|
14
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
15
|
+
Classifier: Intended Audience :: Financial and Insurance Industry
|
|
16
|
+
Classifier: Intended Audience :: Science/Research
|
|
17
|
+
Classifier: Operating System :: OS Independent
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Office/Business :: Financial
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
24
|
+
Classifier: Typing :: Typed
|
|
25
|
+
Requires-Python: >=3.11
|
|
26
|
+
Requires-Dist: click>=8.1
|
|
27
|
+
Requires-Dist: jinja2>=3.1
|
|
28
|
+
Requires-Dist: numpy>=1.26
|
|
29
|
+
Requires-Dist: pandas>=2.1
|
|
30
|
+
Requires-Dist: pydantic<3,>=2.6
|
|
31
|
+
Requires-Dist: pyyaml>=6.0
|
|
32
|
+
Provides-Extra: all
|
|
33
|
+
Requires-Dist: fastapi>=0.110; extra == 'all'
|
|
34
|
+
Requires-Dist: httpx>=0.27; extra == 'all'
|
|
35
|
+
Requires-Dist: mlflow-skinny>=2.12; extra == 'all'
|
|
36
|
+
Requires-Dist: psycopg[binary]>=3.1; extra == 'all'
|
|
37
|
+
Requires-Dist: python-docx>=1.1; extra == 'all'
|
|
38
|
+
Requires-Dist: python-multipart>=0.0.9; extra == 'all'
|
|
39
|
+
Requires-Dist: streamlit>=1.50; extra == 'all'
|
|
40
|
+
Requires-Dist: uvicorn>=0.29; extra == 'all'
|
|
41
|
+
Provides-Extra: api
|
|
42
|
+
Requires-Dist: fastapi>=0.110; extra == 'api'
|
|
43
|
+
Requires-Dist: python-multipart>=0.0.9; extra == 'api'
|
|
44
|
+
Requires-Dist: uvicorn>=0.29; extra == 'api'
|
|
45
|
+
Provides-Extra: dashboard
|
|
46
|
+
Requires-Dist: httpx>=0.27; extra == 'dashboard'
|
|
47
|
+
Requires-Dist: streamlit>=1.50; extra == 'dashboard'
|
|
48
|
+
Provides-Extra: dev
|
|
49
|
+
Requires-Dist: fastapi>=0.110; extra == 'dev'
|
|
50
|
+
Requires-Dist: httpx>=0.27; extra == 'dev'
|
|
51
|
+
Requires-Dist: jsonschema>=4.21; extra == 'dev'
|
|
52
|
+
Requires-Dist: mlflow-skinny>=2.12; extra == 'dev'
|
|
53
|
+
Requires-Dist: mypy>=1.10; extra == 'dev'
|
|
54
|
+
Requires-Dist: pandas-stubs; extra == 'dev'
|
|
55
|
+
Requires-Dist: psycopg[binary]>=3.1; extra == 'dev'
|
|
56
|
+
Requires-Dist: pytest-cov>=5; extra == 'dev'
|
|
57
|
+
Requires-Dist: pytest>=8; extra == 'dev'
|
|
58
|
+
Requires-Dist: python-docx>=1.1; extra == 'dev'
|
|
59
|
+
Requires-Dist: python-multipart>=0.0.9; extra == 'dev'
|
|
60
|
+
Requires-Dist: ruff>=0.6; extra == 'dev'
|
|
61
|
+
Requires-Dist: streamlit>=1.50; extra == 'dev'
|
|
62
|
+
Requires-Dist: types-pyyaml; extra == 'dev'
|
|
63
|
+
Requires-Dist: uvicorn>=0.29; extra == 'dev'
|
|
64
|
+
Provides-Extra: docs
|
|
65
|
+
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
|
|
66
|
+
Requires-Dist: mkdocs<2,>=1.6; extra == 'docs'
|
|
67
|
+
Provides-Extra: docx
|
|
68
|
+
Requires-Dist: python-docx>=1.1; extra == 'docx'
|
|
69
|
+
Provides-Extra: mlflow
|
|
70
|
+
Requires-Dist: mlflow-skinny>=2.12; extra == 'mlflow'
|
|
71
|
+
Provides-Extra: postgres
|
|
72
|
+
Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'
|
|
73
|
+
Description-Content-Type: text/markdown
|
|
74
|
+
|
|
75
|
+
# AI-MRG Framework
|
|
76
|
+
|
|
77
|
+
**An open-source, full-lifecycle AI and model risk governance toolkit for U.S. regulated industries — starting with financial services.**
|
|
78
|
+
|
|
79
|
+
> Status: **v0.3 (Phase 3 complete)**. New in v0.3: a **web dashboard**, **MLflow** integration, **Docker Compose**, the generative/agentic AI track (evaluation, red-team and agent-permission checks mapped to NIST AI 600-1), Colorado SB 26-189 controls and draft notices, and verifiable examination packages. From v0.2: Inventory, classification, risk tiering, control planning, automated checks (data, performance, stability, outcomes, **fair lending**, **adverse-action reasons**), a gated **lifecycle workflow** with independent approval, a tamper-evident evidence trail, findings with aging, reports in Markdown and Word, a **REST API** with role-based access, **PostgreSQL** support and signed **webhooks**. Next: practitioner review, pilots and the 1.0 hardening (Phase 4). See [`docs/ROADMAP.md`](docs/ROADMAP.md). Pack content has **not yet been reviewed by practitioners**.
|
|
80
|
+
|
|
81
|
+
[](https://github.com/abiroland/ai-mrg-framework/actions/workflows/ci.yml)
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Why this exists
|
|
86
|
+
|
|
87
|
+
U.S. guidance tells institutions *what* good AI and model governance looks like. Turning that into day-to-day practice is the hard part. That means inventories, risk tiers, validation evidence, fairness testing, adverse-action reasons, monitoring thresholds and audit-ready documents. Enterprise platforms do this well, but they are licensed products. Community banks, credit unions, fintech start-ups and academic researchers often cannot justify the cost.
|
|
88
|
+
|
|
89
|
+
The 2026 regulatory reset makes the gap sharper:
|
|
90
|
+
|
|
91
|
+
- **SR 26-2 / OCC Bulletin 2026-13 (April 17, 2026)** replaced SR 11-7. It is principles-based and risk-based, sets no enforceable standards and is aimed mainly at banks over $30B in assets. **It explicitly excludes generative and agentic AI.** Institutions are told to cover those with their own governance practices.
|
|
92
|
+
- **ECOA / Regulation B** still require specific, accurate adverse-action reasons, whatever the model's complexity (CFPB Circulars 2022-03 and 2023-03).
|
|
93
|
+
- **Colorado SB 26-189** brings automated-decision-making obligations for lending and other consequential decisions starting **January 1, 2027**.
|
|
94
|
+
- **NIST AI RMF 1.0** and its **Generative AI Profile (NIST AI 600-1)** remain the main voluntary reference. A revision is in progress.
|
|
95
|
+
|
|
96
|
+
AI-MRG turns these sources into **versioned control catalogs, automated checks, evidence trails and document templates** that any institution can run locally, with no license fee, no vendor account and no telemetry.
|
|
97
|
+
|
|
98
|
+
## What it will do
|
|
99
|
+
|
|
100
|
+
| Capability | Description |
|
|
101
|
+
|---|---|
|
|
102
|
+
| **Inventory & classification** | Register every model and AI system. Classify it as *model* under SR 26-2, or as GenAI or agentic AI, and route it to the right governance track. |
|
|
103
|
+
| **Risk tiering** | Configurable scoring on inherent risk, exposure, purpose, materiality and aggregate risk, using SR 26-2's risk factors. |
|
|
104
|
+
| **Control catalog** | Lifecycle controls stored as data (YAML), each with its regulatory references, required evidence and applicability rules. |
|
|
105
|
+
| **Checks library** | Python checks for data quality, performance, stability, outcomes analysis, fair lending and adverse-action reason quality. |
|
|
106
|
+
| **Evidence & audit trail** | Append-only, hash-chained evidence records linked to controls, findings and approvals. |
|
|
107
|
+
| **Document generation** | Development documents, validation reports, monitoring reports, adverse-action reason maps and inventory reports. |
|
|
108
|
+
| **Dashboard** | A web UI for inventory, review workflows, findings and monitoring. |
|
|
109
|
+
|
|
110
|
+
## What it is not
|
|
111
|
+
|
|
112
|
+
- Not legal advice, and not a certification. Using AI-MRG does not by itself make an institution compliant.
|
|
113
|
+
- Not a replacement for independent validation or human judgment. It structures and evidences that work.
|
|
114
|
+
- Not a hosted service. You run it yourself.
|
|
115
|
+
|
|
116
|
+
## Quick start
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
git clone https://github.com/abiroland/ai-mrg-framework
|
|
120
|
+
cd ai-mrg-framework
|
|
121
|
+
pip install -e ".[dev]"
|
|
122
|
+
|
|
123
|
+
# A complete run on a simulated credit model: registry, evidence, findings, reports
|
|
124
|
+
python examples/credit-scorecard/run_example.py demo
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Or run PostgreSQL, the API and the dashboard together:
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
POSTGRES_PASSWORD='choose-one' docker compose up -d --build
|
|
131
|
+
docker compose exec api cat /data/bootstrap-admin-token # sign in at http://127.0.0.1:8501
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+

|
|
135
|
+
|
|
136
|
+
Then follow [Getting started](docs/getting-started.md) for the step-by-step workflow (`aimrg init → register → classify → tier → plan → check run → report render → audit verify`). See [Checks](docs/checks.md) and [Writing packs](docs/packs.md) for details.
|
|
137
|
+
|
|
138
|
+
## Documentation
|
|
139
|
+
|
|
140
|
+
- [Architecture](docs/ARCHITECTURE.md): system design, modules, data model, interfaces
|
|
141
|
+
- [Regulatory map](docs/REGULATORY_MAP.md): how controls trace to SR 26-2, ECOA/Reg B, NIST AI RMF, Colorado and others
|
|
142
|
+
- [Roadmap](docs/ROADMAP.md): phased delivery plan and success metrics
|
|
143
|
+
- [Architecture decision records](docs/adr/)
|
|
144
|
+
|
|
145
|
+
## Scope by release
|
|
146
|
+
|
|
147
|
+
- **Financial services (U.S. banking and consumer lending)**: first, v0.1–v1.0
|
|
148
|
+
- **Healthcare**: planned as a second sector pack on the same core, after v1.0
|
|
149
|
+
|
|
150
|
+
## Contributing
|
|
151
|
+
|
|
152
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md). Regulatory content changes must cite a primary source.
|
|
153
|
+
|
|
154
|
+
## License
|
|
155
|
+
|
|
156
|
+
Apache License 2.0. See [ADR-0001](docs/adr/0001-license-apache-2.md).
|
ai_mrg-0.3.0/README.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# AI-MRG Framework
|
|
2
|
+
|
|
3
|
+
**An open-source, full-lifecycle AI and model risk governance toolkit for U.S. regulated industries — starting with financial services.**
|
|
4
|
+
|
|
5
|
+
> Status: **v0.3 (Phase 3 complete)**. New in v0.3: a **web dashboard**, **MLflow** integration, **Docker Compose**, the generative/agentic AI track (evaluation, red-team and agent-permission checks mapped to NIST AI 600-1), Colorado SB 26-189 controls and draft notices, and verifiable examination packages. From v0.2: Inventory, classification, risk tiering, control planning, automated checks (data, performance, stability, outcomes, **fair lending**, **adverse-action reasons**), a gated **lifecycle workflow** with independent approval, a tamper-evident evidence trail, findings with aging, reports in Markdown and Word, a **REST API** with role-based access, **PostgreSQL** support and signed **webhooks**. Next: practitioner review, pilots and the 1.0 hardening (Phase 4). See [`docs/ROADMAP.md`](docs/ROADMAP.md). Pack content has **not yet been reviewed by practitioners**.
|
|
6
|
+
|
|
7
|
+
[](https://github.com/abiroland/ai-mrg-framework/actions/workflows/ci.yml)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Why this exists
|
|
12
|
+
|
|
13
|
+
U.S. guidance tells institutions *what* good AI and model governance looks like. Turning that into day-to-day practice is the hard part. That means inventories, risk tiers, validation evidence, fairness testing, adverse-action reasons, monitoring thresholds and audit-ready documents. Enterprise platforms do this well, but they are licensed products. Community banks, credit unions, fintech start-ups and academic researchers often cannot justify the cost.
|
|
14
|
+
|
|
15
|
+
The 2026 regulatory reset makes the gap sharper:
|
|
16
|
+
|
|
17
|
+
- **SR 26-2 / OCC Bulletin 2026-13 (April 17, 2026)** replaced SR 11-7. It is principles-based and risk-based, sets no enforceable standards and is aimed mainly at banks over $30B in assets. **It explicitly excludes generative and agentic AI.** Institutions are told to cover those with their own governance practices.
|
|
18
|
+
- **ECOA / Regulation B** still require specific, accurate adverse-action reasons, whatever the model's complexity (CFPB Circulars 2022-03 and 2023-03).
|
|
19
|
+
- **Colorado SB 26-189** brings automated-decision-making obligations for lending and other consequential decisions starting **January 1, 2027**.
|
|
20
|
+
- **NIST AI RMF 1.0** and its **Generative AI Profile (NIST AI 600-1)** remain the main voluntary reference. A revision is in progress.
|
|
21
|
+
|
|
22
|
+
AI-MRG turns these sources into **versioned control catalogs, automated checks, evidence trails and document templates** that any institution can run locally, with no license fee, no vendor account and no telemetry.
|
|
23
|
+
|
|
24
|
+
## What it will do
|
|
25
|
+
|
|
26
|
+
| Capability | Description |
|
|
27
|
+
|---|---|
|
|
28
|
+
| **Inventory & classification** | Register every model and AI system. Classify it as *model* under SR 26-2, or as GenAI or agentic AI, and route it to the right governance track. |
|
|
29
|
+
| **Risk tiering** | Configurable scoring on inherent risk, exposure, purpose, materiality and aggregate risk, using SR 26-2's risk factors. |
|
|
30
|
+
| **Control catalog** | Lifecycle controls stored as data (YAML), each with its regulatory references, required evidence and applicability rules. |
|
|
31
|
+
| **Checks library** | Python checks for data quality, performance, stability, outcomes analysis, fair lending and adverse-action reason quality. |
|
|
32
|
+
| **Evidence & audit trail** | Append-only, hash-chained evidence records linked to controls, findings and approvals. |
|
|
33
|
+
| **Document generation** | Development documents, validation reports, monitoring reports, adverse-action reason maps and inventory reports. |
|
|
34
|
+
| **Dashboard** | A web UI for inventory, review workflows, findings and monitoring. |
|
|
35
|
+
|
|
36
|
+
## What it is not
|
|
37
|
+
|
|
38
|
+
- Not legal advice, and not a certification. Using AI-MRG does not by itself make an institution compliant.
|
|
39
|
+
- Not a replacement for independent validation or human judgment. It structures and evidences that work.
|
|
40
|
+
- Not a hosted service. You run it yourself.
|
|
41
|
+
|
|
42
|
+
## Quick start
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
git clone https://github.com/abiroland/ai-mrg-framework
|
|
46
|
+
cd ai-mrg-framework
|
|
47
|
+
pip install -e ".[dev]"
|
|
48
|
+
|
|
49
|
+
# A complete run on a simulated credit model: registry, evidence, findings, reports
|
|
50
|
+
python examples/credit-scorecard/run_example.py demo
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Or run PostgreSQL, the API and the dashboard together:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
POSTGRES_PASSWORD='choose-one' docker compose up -d --build
|
|
57
|
+
docker compose exec api cat /data/bootstrap-admin-token # sign in at http://127.0.0.1:8501
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+

|
|
61
|
+
|
|
62
|
+
Then follow [Getting started](docs/getting-started.md) for the step-by-step workflow (`aimrg init → register → classify → tier → plan → check run → report render → audit verify`). See [Checks](docs/checks.md) and [Writing packs](docs/packs.md) for details.
|
|
63
|
+
|
|
64
|
+
## Documentation
|
|
65
|
+
|
|
66
|
+
- [Architecture](docs/ARCHITECTURE.md): system design, modules, data model, interfaces
|
|
67
|
+
- [Regulatory map](docs/REGULATORY_MAP.md): how controls trace to SR 26-2, ECOA/Reg B, NIST AI RMF, Colorado and others
|
|
68
|
+
- [Roadmap](docs/ROADMAP.md): phased delivery plan and success metrics
|
|
69
|
+
- [Architecture decision records](docs/adr/)
|
|
70
|
+
|
|
71
|
+
## Scope by release
|
|
72
|
+
|
|
73
|
+
- **Financial services (U.S. banking and consumer lending)**: first, v0.1–v1.0
|
|
74
|
+
- **Healthcare**: planned as a second sector pack on the same core, after v1.0
|
|
75
|
+
|
|
76
|
+
## Contributing
|
|
77
|
+
|
|
78
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md). Regulatory content changes must cite a primary source.
|
|
79
|
+
|
|
80
|
+
## License
|
|
81
|
+
|
|
82
|
+
Apache License 2.0. See [ADR-0001](docs/adr/0001-license-apache-2.md).
|