Skip to main content

SSBC: Small-Sample Beta Correction

PyPI version Documentation Status

Small-Sample Beta Correction provides PAC (Probably Approximately Correct) guarantees for conformal prediction with small calibration sets.

Overview

SSBC addresses the challenge of constructing valid prediction sets when you have limited calibration data. Traditional conformal prediction assumes large calibration sets, but in practice, data is often scarce. SSBC provides finite-sample PAC guarantees and rigorous operational bounds for deployment.

What Makes SSBC Unique?

Unlike asymptotic methods, SSBC provides:

  1. Finite-Sample PAC Coverage (via SSBC algorithm)

    • Rigorous guarantees that hold for ANY sample size
    • Automatically adapts to class imbalance via Mondrian conformal prediction
    • Example: "≥90% coverage with 95% probability" even with n=50
  2. Rigorous Operational Bounds (via LOO-CV + Clopper-Pearson)

    • PAC-controlled bounds on automation rates, error rates, escalation rates
    • Confidence intervals account for estimation uncertainty
    • Example: "Singleton rate [0.85, 0.97] with 90% PAC guarantee"
  3. Uncertainty Quantification

    • Bootstrap analysis for recalibration uncertainty
    • Cross-conformal validation for finite-sample diagnostics
    • Empirical validation for verifying theoretical guarantees
  4. Contract-Ready Guarantees

    • Transform theory into deployable systems
    • Resource planning (human oversight needs)
    • SLA compliance (performance bounds)

Core Statistical Properties

🎯 Distribution-Free: No assumptions about data distribution 🎯 Model-Agnostic: Works with ANY probabilistic classifier 🎯 Frequentist: Valid frequentist guarantees, no prior needed 🎯 Non-Bayesian: No Bayesian assumptions or hyperpriors 🎯 Finite-Sample: Exact guarantees for small n, not asymptotic 🎯 Exchangeability Only: Minimal assumption (test/calibration exchangeable)

📖 For detailed theory and deployment guide, see docs/theory.md

Installation

pip install ssbc

Or from source:

git clone https://github.com/phzwart/ssbc.git
cd ssbc
pip install -e .

Quick Start

Unified Workflow (Recommended)

The complete workflow is available through a single function:

from ssbc import BinaryClassifierSimulator, generate_rigorous_pac_report

# Generate or load calibration data
sim = BinaryClassifierSimulator(
    p_class1=0.2,
    beta_params_class0=(1, 7),
    beta_params_class1=(5, 2),
    seed=42
)
labels, probs = sim.generate(n_samples=100)

# Generate comprehensive PAC report with operational bounds
report = generate_rigorous_pac_report(
    labels=labels,
    probs=probs,
    alpha_target=0.10,     # Target 90% coverage
    delta=0.10,            # 90% PAC confidence
    test_size=1000,        # Expected deployment size
    use_union_bound=True,  # Simultaneous guarantees
)

# Access results
pac_bounds = report['pac_bounds_marginal']
print(f"Singleton rate: {pac_bounds['singleton_rate_bounds']}")
print(f"Expected: {pac_bounds['expected_singleton_rate']:.3f}")

Output includes:

  • ✅ PAC coverage guarantees (SSBC-corrected thresholds)
  • ✅ Rigorous operational bounds (singleton, doublet, abstention, error rates)
  • ✅ Per-class and marginal statistics
  • ✅ Class-conditional error metrics (P(error | singleton & class))

Core SSBC Algorithm

For fine-grained control, use the core algorithm directly:

from ssbc import ssbc_correct

result = ssbc_correct(
    alpha_target=0.10,  # Target 10% miscoverage
    n=50,               # Calibration set size
    delta=0.10,         # PAC parameter (90% confidence)
    mode="beta"         # Infinite test window
)

print(f"Corrected α: {result.alpha_corrected:.4f}")
print(f"u*: {result.u_star}")

Validation and Diagnostics

Empirically validate your PAC bounds:

from ssbc import validate_pac_bounds, print_validation_results

# Generate report
report = generate_rigorous_pac_report(labels, probs, delta=0.10)

# Validate empirically
validation = validate_pac_bounds(
    report=report,
    simulator=sim,
    test_size=1000,
    n_trials=10000
)

# Print results
print_validation_results(validation)

Cross-conformal validation for calibration diagnostics:

from ssbc import cross_conformal_validation

results = cross_conformal_validation(
    labels=labels,
    probs=probs,
    n_folds=10,
    alpha_target=0.10,
    delta=0.10
)

print(f"Singleton rate: {results['marginal']['singleton']['mean']:.3f}")
print(f"Std dev: {results['marginal']['singleton']['std']:.3f}")

Key Features

  • Small-Sample Correction: PAC-valid conformal prediction for small calibration sets
  • Mondrian Conformal Prediction: Per-class calibration for handling class imbalance
  • PAC Operational Bounds: Rigorous bounds on deployment rates (LOO-CV + Clopper-Pearson)
  • LOO-CV Uncertainty Correction: Small-sample uncertainty quantification
  • Method Comparison: Analytical, exact, and Hoeffding bounds comparison
  • Empirical Validation: Verify theoretical guarantees in practice
  • Comprehensive Statistics: Detailed reporting with exact confidence intervals
  • Hyperparameter Tuning: Interactive parallel coordinates visualization
  • Simulation Tools: Built-in data generators for testing

Examples

The examples/ directory contains comprehensive demonstrations:

Essential Examples

# Core algorithm
python examples/ssbc_core_example.py

# Mondrian conformal prediction
python examples/mondrian_conformal_example.py

# Complete workflow with all uncertainty analyses
python examples/complete_workflow_example.py

# SLA/deployment contracts
python examples/sla_example.py

# Alpha scanning across thresholds
python examples/alpha_scan_example.py

# Empirical validation
python examples/pac_validation_example.py

Understanding the Output

Per-Class Statistics (Conditioned on True Label)

For each class, the report shows:

  • Abstentions: Empty prediction sets (no confident prediction)
  • Singletons: Single-label predictions (automated decisions)
  • Doublets: Both labels included (escalated to human review)
  • Singleton Error Rate: P(error | singleton prediction)

Marginal Statistics (Deployment View)

Overall performance metrics (deployment perspective):

  • Coverage: Fraction of predictions containing the true label
  • Automation Rate: Fraction of confident predictions (singletons)
  • Escalation Rate: Fraction requiring human review (doublets + abstentions)
  • Error Rate: Among automated decisions

PAC Operational Bounds

Rigorous bounds on all operational metrics:

  • Computed via Leave-One-Out Cross-Validation (LOO-CV)
  • Clopper-Pearson confidence intervals account for estimation uncertainty
  • Union bound ensures all metrics hold simultaneously
  • Valid for any future test set from the same distribution

Citation

If you use SSBC in your research, please cite:

@software{ssbc2024,
  author = {Zwart, Petrus H},
  title = {SSBC: Small-Sample Beta Correction},
  year = {2024},
  url = {https://github.com/phzwart/ssbc}
}

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

MIT License - see LICENSE file for details.

Credits

This package was created with Cookiecutter and the audreyfeldroy/cookiecutter-pypackage project template.

Release files for ssbc 1.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ssbc 1.4.0
File Size Uploaded
ssbc-1.4.0.tar.gz 159.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ssbc 1.4.0
File Interpreter ABI Platform
ssbc-1.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 266.5 kB

Release files / ssbc-1.4.0.tar.gz

Download URL ssbc-1.4.0.tar.gz
Size 159.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e88e27f9d84728a5989a19e0535302b9aef1aea59da6ccf9f634a7cf4f46b62c
BLAKE2b-256 checksum
How to use checksums
a6ebc6d451cb274037be8f4b9be1dd48fa23f3115c21edb3652c23ec0c2ca783
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 6, 2025.

Transparency log

Release files / ssbc-1.4.0-py3-none-any.whl

Download URL ssbc-1.4.0-py3-none-any.whl
Size 107.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7509c1028538e37cf3d3b1ac11db5e8d60d8df54bf49dcc36fc2395cfbc5c2f3
BLAKE2b-256 checksum
How to use checksums
aa8b315ab326a51fc33adafba2a3330ea8df502e2c6c63c584c9fe72a0adb789
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 6, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

1.4.0 This release

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page