Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Calibrated Explanations v0.11
Calibrated Explanations v0.11

Start here

  • Get started
    • Installation
    • Quick API
    • Classification quickstart
    • Regression quickstart
    • Guarded explanations quickstart
    • 60-second decision tree
    • Environment troubleshooting
  • Practitioner hub
    • Task API Comparison
    • Practitioner playbooks
      • Mondrian (Conditional) Calibration Playbook
      • Ensured Explanations Playbook
      • Decision Policies Guide
      • Satisfying EU AI Act Requirements with calibrated_explanations
      • Satisfying EU Data, Liability, and Algorithmic Regulations with calibrated_explanations
      • Integrate with scikit-learn pipelines
      • Export explanations
      • Release checklist
      • Documentation section owners
    • Practitioner advanced topics
      • Use external plugins
      • Modality plugin selection
      • Normalization and Difficulty Estimation
      • Configure telemetry
      • Tune runtime performance (opt-in)
      • Reject Policy Guide
      • Parallel execution playbook (opt-in)
      • Explanation retrieval
      • Plot explanations with PlotSpec
      • Telemetry (relocated)
      • Performance Tuning Guide
    • Narrative Template Customization
  • Researcher hub
    • Replication workflow
      • Export explanations
      • Interpret calibrated explanations
    • Researcher advanced topics
      • Theory & literature
      • Difficulty-Normalized Reject for Conformal Classification
      • Probabilistic and interval regression
      • Alternative explanations and ensured filters
      • Configure telemetry
    • Future Work & Research Directions
  • Contributor hub
    • Plugin contract
    • Notebook Policy for calibrated_explanations
    • Performance Harness
    • Advanced plugin wiring and configuration
    • Extending guides
      • Integrate with scikit-learn pipelines
      • Configure telemetry
      • Navigation crosswalk
      • API reference
        • calibrated_explanations.core.CalibratedExplainer
        • calibrated_explanations.core.WrapCalibratedExplainer
        • calibrated_explanations.explanations.CalibratedExplanations
        • calibrated_explanations.explanations.AlternativeExplanations
        • calibrated_explanations.explanations.CalibratedExplanation
        • calibrated_explanations.explanations.FactualExplanation
        • calibrated_explanations.explanations.AlternativeExplanation
        • calibrated_explanations.explanations.FastExplanation
        • calibrated_explanations.utils.helper
        • calibrated_explanations.core.exceptions
        • calibrated_explanations.core.validation
        • calibrated_explanations.api.params
        • calibrated_explanations.api.config
    • Advanced contributor tooling
      • Tune runtime performance (opt-in)
      • Optional telemetry scaffolding
      • Plot explanations with PlotSpec
    • Agent skill catalogue
    • Migration guides
      • Terminology Standardization
      • Deprecation & Migration Guide
      • ADR-033 Migration Notes (v0.11.0)

Core references

  • Shared foundations
    • Concepts & architecture
      • Probabilistic and interval regression
      • Alternative explanations and ensured filters
      • Architecture Overview
      • Error handling and validation
      • Explanation Structures
      • Guarded explanations
      • Calibrated interval semantics
      • Terminology Standardization
      • Terminology: thresholded vs probabilistic regression
      • CE Parameter Reference
    • How-to guides
      • Integrate with scikit-learn pipelines
      • Configure telemetry
      • Configure runtime behaviour (ConfigManager)
      • Safe defaults for production deployments
      • Export explanations
      • Generate narratives with to_narrative
      • Plot explanations with PlotSpec
      • Interpret calibrated explanations
      • Tune runtime performance (opt-in)
    • Reference
      • API reference
        • calibrated_explanations.core.CalibratedExplainer
        • calibrated_explanations.core.WrapCalibratedExplainer
        • calibrated_explanations.explanations.CalibratedExplanations
        • calibrated_explanations.explanations.AlternativeExplanations
        • calibrated_explanations.explanations.CalibratedExplanation
        • calibrated_explanations.explanations.FactualExplanation
        • calibrated_explanations.explanations.AlternativeExplanation
        • calibrated_explanations.explanations.FastExplanation
        • calibrated_explanations.utils.helper
        • calibrated_explanations.core.exceptions
        • calibrated_explanations.core.validation
        • calibrated_explanations.api.params
        • calibrated_explanations.api.config
      • Explanation Schema v1
      • Citing calibrated-explanations
      • Bibtex Entries
    • Governance & support
      • Documentation section owners
      • Release checklist
      • Navigation crosswalk
      • Optional telemetry scaffolding
      • Governance Events (Plugin + Config Lifecycle)
      • Documentation test policy
      • Coverage waiver inventory
      • Release notes
      • Pull Request Guide
  • Tasks and capabilities
    • Capabilities manifest
    • Classification (Binary & Multiclass)
    • Conformal Interval Regression (CPS)
    • Probabilistic (Thresholded) Regression
  • API Reference
    • Calibrated Explainer API
    • CLI reference
    • Plugin registry reference
    • Serialization & schema reference
    • Visualization & PlotSpec reference

Extensions and project docs

  • Plugins
  • Migration guides
    • Terminology Standardization
    • Deprecation & Migration Guide
    • ADR-033 Migration Notes (v0.11.0)
  • Upgrade guides
    • v1.0.0 upgrade checklist
  • External plugins
  • Changelog and release references
  • RTD tier map
  • Engineering Standards
    • Standard-001: Internal nomenclature standardisation
    • Standard-002: Code Documentation Standardization
    • Standard-003: Test Coverage Standardization
    • Standard-004: Documentation Audience Standard
    • Standard-005: Logging and Observability
  • CE-First Calibrated Explanations Guide (OSS)
  • AI Agent Setup Guide for calibrated_explanations
  • Legacy Plotting Reference (Maintenance Only)
  • Calibrated Explanations comparisons (CE-first)
  • Roadmap
  • Roadmap
  • Citing calibrated-explanations
  • Bibtex Entries
Back to top
View this page

Upgrade guides¶

Checklists and safe-defaults guides for upgrading to new major versions.

  • v1.0.0 upgrade checklist
    • 1. Environment variables
    • 2. pyproject.toml configuration
    • 3. API changes from v0.11.x
    • 4. Guarded explanation migration
    • 5. ExplainerBuilder and ExplainerConfig wiring
    • 6. Caching
    • 7. Parallel execution
    • 8. Plugin testing and diagnostics
    • 9. Reject framework
Next
v1.0.0 upgrade checklist
Previous
Plugins
Copyright © 2023, Helena Löfström, Tuwe Löfström
Made with Sphinx and @pradyunsg's Furo
Last updated on Jun 17, 2026