Skip to main content

A pre-clinical Edge-AI SDK for diabetes management validation.

Project description

IINTS-AF SDK

PyPI version Python Package CI Site

IINTS-AF is a safety-first SDK for insulin-algorithm research. It lets you simulate, validate, and report results with reproducible artifacts.

Docs (GitHub Pages): python35.github.io/IINTS-SDK

What You Can Do

  • Run virtual patient simulations.
  • Test algorithm safety gates (deterministic supervisor).
  • Add optional AI glucose forecasting.
  • Validate datasets before training/evaluation.
  • Generate audit-ready CSV/JSON/PDF/HTML outputs.

Quick Start

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
pip install iints-sdk-python35
iints doctor --smoke-run
iints quickstart --project-name iints_quickstart
cd iints_quickstart
iints presets run --name baseline_t1d --algo algorithms/example_algorithm.py

AI Assistant (Ministral 3 Open-Weight via Ollama)

The SDK now includes a research-only AI assistant layer for explanations and run summaries. It is gated by MDMP verification before any LLM call is allowed.

Use an active virtual environment for the full flow:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip
python -m pip install -e ".[mdmp]"

Run the open local Mistral model locally with Ollama:

python -m pip install -e ".[mdmp]"
ollama pull ministral-3:8b
iints ai models

Recommended first-time setup:

ollama pull ministral-3:8b
iints ai local-check --model ministral-3:8b

Recommended flow:

iints quickstart --project-name iints_quickstart
cd iints_quickstart
iints presets run --name baseline_t1d --algo algorithms/example_algorithm.py
iints ai prepare results/<run_id>
iints ai report results/<run_id>

Direct JSON mode still works if you already have your own payloads and signed MDMP artifact:

iints ai explain results/step.json \
  --mdmp-cert results/report.signed.mdmp

Notes:

  • AI analysis is blocked if the MDMP artifact is invalid.
  • Minimum required MDMP grade defaults to research_grade.
  • The SDK now targets the open local Ministral 3 Ollama model by default.
  • Users can choose a larger or smaller local Mistral-family model with --model ....
  • Large JSON payloads are clipped automatically before prompt generation to keep local inference stable.
  • iints ai prepare <run_dir> now creates AI-ready JSON payloads and, when MDMP is installed, a local development certificate plus keypair in <run_dir>/ai/.
  • After iints ai prepare, you can point iints ai explain|trends|anomalies|report directly at the run directory.
  • Output is research-only and not medical advice.

Troubleshooting:

  • If iints ai ... says No such command 'ai', your environment usually still has a legacy iints package installed alongside iints-sdk-python35.
  • Run iints-sdk-doctor first.
  • If it reports a conflict, repair the environment with:
python -m pip uninstall -y iints iints-sdk-python35
python -m pip install -U "iints-sdk-python35[mdmp]==1.1.2"
hash -r

MDMP (Short)

MDMP is the data-quality protocol used by IINTS.

  • Contract: defines expected columns, types, units, and bounds.
  • Validation: checks a dataset against the contract.
  • Fingerprint + Grade: writes deterministic hashes and a grade (draft, research_grade, clinical_grade).
  • Visualizer: builds a single-file HTML report for audits.

Use the dedicated namespace:

iints mdmp template --output-path mdmp_contract.yaml
iints mdmp validate mdmp_contract.yaml data/my_cgm.csv --output-json results/mdmp_report.json
iints mdmp visualizer results/mdmp_report.json --output-html results/mdmp_dashboard.html

Use standalone MDMP backend (optional):

export IINTS_MDMP_BACKEND=mdmp_core

Staleness / lineage checks (standalone MDMP CLI):

mdmp fingerprint-record data/my_cgm.csv --output-json results/fingerprint.json --expires-days 365
mdmp fingerprint-check results/fingerprint.json data/my_cgm.csv
mdmp lineage-card-refresh results/mdmp_model_card.yaml
mdmp registry init --registry registry/mdmp_registry.json
mdmp registry push --registry registry/mdmp_registry.json --report results/mdmp_report.json

Dual Repo Workflow

  • SDK repo: python35/IINTS-SDK
  • MDMP repo: python35/MDMP

Local helper scripts:

  • tools/dev/dual_repo_status.sh
  • tools/dev/dual_repo_commit_push.sh

Full process: docs/DUAL_REPO_WORKFLOW.md

MDMP sync CI gate:

  • .github/workflows/mdmp-sync.yml
  • Uses private-repo checkout when MDMP_REPO_TOKEN is configured.
  • Falls back to mdmp-protocol from PyPI when checkout is unavailable.
  • Auto dependency updates for MDMP are handled via Dependabot (.github/dependabot.yml).

Tools Layout

Repository helpers are now grouped by purpose:

  • scripts/: simple user-facing shortcuts like test, lint, and demo entrypoints
  • tools/ci/: CI gates and policy checks
  • tools/dev/: maintainer workflows and multi-repo helpers
  • tools/docs/: manual and documentation builders
  • tools/data/: dataset import and conversion utilities
  • tools/analysis/: plotting, diagnostics, and report helpers
  • tools/assets/: branding and asset generation helpers

Reference: tools/README.md

Typical Workflow

  1. Prepare or import data.
  2. Validate data with MDMP.
  3. Run simulation or forecast evaluation.
  4. Review report artifacts and metrics.

Key Commands

iints run-full --algo algorithms/example_algorithm.py --scenario-path scenarios/clinic_safe_baseline.json --output-dir results/run_full
iints scorecard --algo algorithms/example_algorithm.py --profile research_default --output-dir results/scorecard
iints study-ready --algo algorithms/example_algorithm.py --output-dir results/study_ready
iints sources --output-json results/source_manifest.json

Documentation

Safety Notice

For research use only. Not a medical device. No clinical dosing advice.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iints_sdk_python35-1.1.2.tar.gz (937.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iints_sdk_python35-1.1.2-py3-none-any.whl (985.7 kB view details)

Uploaded Python 3

File details

Details for the file iints_sdk_python35-1.1.2.tar.gz.

File metadata

  • Download URL: iints_sdk_python35-1.1.2.tar.gz
  • Upload date:
  • Size: 937.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for iints_sdk_python35-1.1.2.tar.gz
Algorithm Hash digest
SHA256 2a5e2c65c1687bbe98001a33ef794632829695131de18fac46b6ceb6c318f3ab
MD5 1b61b495311bad79c5c0a2d407817645
BLAKE2b-256 1a3830aaba01eb102476ac44e2aefd2b0b7e6eb2fcc5b934f9edc95a9c7303a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for iints_sdk_python35-1.1.2.tar.gz:

Publisher: publish-pypi.yml on python35/IINTS-SDK

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file iints_sdk_python35-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for iints_sdk_python35-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b2c7693fde84965cc1d15d2e0fe57109b9e8b225884bae6beca1ca2149fdb81f
MD5 1985238cb23ab86530f7d4c2c1404329
BLAKE2b-256 cb9fe9c764d1119a6c9b272f53b287bf1ec181721c1b6abecf865fc24ae2ac0e

See more details on using hashes here.

Provenance

The following attestation bundles were made for iints_sdk_python35-1.1.2-py3-none-any.whl:

Publisher: publish-pypi.yml on python35/IINTS-SDK

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page