Skip to main content

Crate proofframe

Crate proofframe 

Source
Expand description

Native ProofFrame engine for Arrow-backed data contracts.

The crate exposes a Rust-native API by default. The Python extension module is available behind the python feature and is enabled by the PyPI build configuration. Core invariants are stable enough to publish as an alpha: pf-fp-v1 canonical dataset fingerprints, disk-backed exact keyed diffs, privacy-preserving PII findings, leakage checks, and signed proof receipts.

Modules§

receipt
Ed25519-signed proof receipts over canonical JSON reports.

Structs§

ChangedRow
A row present in both datasets whose values changed.
ColumnContract
Rule set applied to a single column during validation.
ColumnProfile
Per-column summary produced while profiling a dataset.
Contract
Validation contract: per-column rules plus a bound on emitted findings.
DiffReport
Exact keyed diff between two datasets.
FastValidationReport
Rules-only validation result that skips profiling and fingerprinting.
Finding
A single rule violation with bounded, row-level evidence.
LeakageReport
Train/test overlap result that exposes only hashed sample identifiers.
PiiFinding
A single PII detection that never carries the matched value.
PiiReport
Aggregated PII scan result with bounded per-cell findings.
Profile
Deterministic dataset profile with a canonical content fingerprint.
ValidationReport
Full validation result: findings plus the dataset profile and fingerprint.

Enums§

DistinctMode
Exact distinct counting can dominate large profiles, so callers can opt out.
ProofFrameError
Errors returned by ProofFrame profiling, validation, diffing, and receipts.

Functions§

detect_leakage_readers
Detect train/test row or key leakage between two Arrow readers.
diff_readers
Compute an exact keyed diff between two Arrow readers.
fingerprint_reader
Return only the canonical dataset fingerprint, without profiling or exact distinct state.
profile_reader
Profile Arrow record batches and return typed Rust metadata.
profile_reader_with_distinct
Profile Arrow record batches with configurable exact distinct counting.
scan_pii_reader
Scan Arrow record batches for high-signal PII patterns.
validate_fast_reader
Validate Arrow record batches with the rules-only fast path.
validate_reader
Validate Arrow record batches with the full profiling path.