Skip to main content

Explainable, safety-first data quality, validation, cleaning, and drift analysis.

Project description

AxiomBraid 2.0

Explainable, safety-first data quality for Python.

AxiomBraid inspects, validates, cleans, compares, and monitors tabular datasets while keeping automated changes conservative, visible, and reproducible.

Installation

pip install axiombraid

Windows:

py -m pip install axiombraid

Optional charts:

pip install "axiombraid[charts]"

Quick start

import axiombraid as AB

result = AB.inspect("students.csv")
AB.report("students.csv")
cleaned = AB.clean("students.csv", risk="low")
AB.export_html("students.csv", "reports/students.html", theme="dark")

Version 2 explainability

result = AB.inspect(
    "students.csv",
    include_confidence=True,
    include_quality_profile=True,
)

AB.report(
    "students.csv",
    include_confidence=True,
    include_quality_profile=True,
)

The quality profile explains Completeness, Uniqueness, Validity, Consistency, and Integrity. Confidence represents evidence strength, not calibrated probability.

Controlled evaluation

clean = AB.read_csv("clean.csv")
corrupted, truth = AB.inject_issues(clean, missing_rate=0.05, duplicate_rate=0.05, invalid_range_rate=0.05, random_state=42)
results = AB.run_evaluation(clean, corruption_config={"missing_rate": 0.05, "duplicate_rate": 0.05, "invalid_range_rate": 0.05, "random_state": 42})

Evaluation metrics operate at issue/column granularity.

Main capabilities

  • Missing values, duplicates, constants, identifiers, outliers, suspicious ranges, text inconsistencies, and date-like text
  • Explainable dataset, column, and five-dimensional quality scoring
  • Evidence-aware confidence with readable console and HTML reports
  • Preview-first, risk-classified, reversible cleaning
  • Validation contracts, fingerprints, leakage screening, schema comparison, and drift history
  • Controlled synthetic corruption with exact ground truth
  • Precision, recall, F1, confidence diagnostics, quality-response evaluation, and benchmarks
  • Streaming, caching, plugins, batch processing, CLI, and Roman Urdu reports

Safety

AxiomBraid does not silently delete outliers, clip invalid values, drop identifiers, or mutate input DataFrames through the functional API.

Diagnostics

print(AB.about())
print(AB.self_check())
print(AB.compatibility_check())

CLI

py -m axiombraid --version
py -m axiombraid inspect data.csv --confidence --quality-profile
py -m axiombraid evaluate clean.csv --output reports/evaluation
py -m axiombraid benchmark data.csv --repeats 3 --output reports/benchmark.json

License: MIT
Repository: https://github.com/Adil307/AxiomBraid

Source-code documentation with Doxygen

AxiomBraid 2.0.0 includes final Doxygen configuration for modules, classes, functions, docstrings, source browsing, examples, and Graphviz diagrams.

Install the tools on Windows:

winget install --id DimitriVanHeesch.Doxygen -e
winget install --id Graphviz.Graphviz -e

Generate and open the documentation without PowerShell execution-policy issues:

.\generate_doxygen.cmd

The generated main page is:

docs/doxygen/html/index.html

See docs/DOXYGEN.md for setup, troubleshooting, CI artifact generation, and reviewer-sharing instructions.

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

axiombraid-2.0.0.tar.gz (110.8 kB view details)

Uploaded Source

Built Distribution

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

axiombraid-2.0.0-py3-none-any.whl (75.6 kB view details)

Uploaded Python 3

File details

Details for the file axiombraid-2.0.0.tar.gz.

File metadata

  • Download URL: axiombraid-2.0.0.tar.gz
  • Upload date:
  • Size: 110.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for axiombraid-2.0.0.tar.gz
Algorithm Hash digest
SHA256 e4f97a5a372cd2e79e51c804bd735de7bf3e205411a8babe628ba57ce90836f0
MD5 6405b229bb5c7f1897e8b5908921e576
BLAKE2b-256 c35c4da6d6dca40ac0952925d5dc7edb4dc2bc4cdf8bdbc217075e29da98a78d

See more details on using hashes here.

Provenance

The following attestation bundles were made for axiombraid-2.0.0.tar.gz:

Publisher: publish-pypi.yml on Adil307/AxiomBraid

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

File details

Details for the file axiombraid-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: axiombraid-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 75.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for axiombraid-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c459039cd41c57667b51dace6e96022feec85f9b9e2fe7676acc047c4db997bf
MD5 b73ce90751508eb1b3067ad3d84c40cb
BLAKE2b-256 784e7f2d6d264f44886037f2c04e8fd8efd4ea57c071cadb6d3d6c57cd507258

See more details on using hashes here.

Provenance

The following attestation bundles were made for axiombraid-2.0.0-py3-none-any.whl:

Publisher: publish-pypi.yml on Adil307/AxiomBraid

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