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
      • Probabilistic and interval regression
      • Alternative explanations and ensured filters
      • Configure telemetry
    • Future Work & Research Directions
  • Contributor hub
    • Plugin contract
    • Notebook Policy for calibrated_explanations
    • 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
    • How-to guides
      • Integrate with scikit-learn pipelines
      • Configure telemetry
      • 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)
  • 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

Navigation crosswalk¶

Track where legacy documentation pages now live in the Standard-004 audience-first information architecture. Update this checklist whenever a page moves or is retired.

Status note: Last updated 2025-11-10 · Per Standard-004 (Documentation Audience Standard) · Supersedes ADR-022.

Legacy → New location mapping¶

Legacy page

New location

Notes

calibrated_explanations.rst (legacy landing page)

:doc:../../index

Landing narrative split into role-based overview and section toctrees with audience-first callouts.

getting_started.md

:doc:../../get-started/index with :doc:../../get-started/installation, :doc:../../get-started/quickstart_classification, :doc:../../get-started/quickstart_regression, :doc:../../get-started/troubleshooting

Content decomposed into dedicated installation, runnable quickstarts, and troubleshooting checklists.

practitioner_guide.md (legacy)

:doc:../../practitioner/index with :doc:../../practitioner/playbooks/index and :doc:../../practitioner/advanced/index

Practitioner core and advanced workflows split: core focuses on factual/alternative explanations; advanced collects optional telemetry and performance tooling.

researcher_guide.md (legacy)

:doc:../../researcher/index with :doc:../../researcher/replication/index and :doc:../../researcher/advanced/index

Research content consolidated: replication workflows, benchmark manifests, and literature map in one hub with advanced observability extras.

contributor_guide.md (legacy)

:doc:../../contributor/index with :doc:../../contributor/plugin-contract and :doc:../../contributor/extending/guides/index

Contributor paths split: plugin contract first (core requirement), then extending guides for CLI and configuration surfaces.

viz_plotspec.md

:doc:../how-to/plot_with_plotspec

PlotSpec guidance converted to a how-to focused on configuration plus telemetry links. Practitioner playbooks reference this for advanced visualization.

architecture.md

:doc:../concepts/index, :doc:../concepts/alternatives, :doc:../concepts/probabilistic_regression

Architecture material split into focused concept pages; optional telemetry moved under :doc:../governance/optional_telemetry so provenance scaffolding is clearly opt-in.

(new) interpretation guide

:doc:../how-to/interpret_explanations

Primary resource for reading factual and alternative explanations, PlotSpec visuals, and telemetry provenance. Linked from all quickstarts.

plugin_guide.md (legacy)

:doc:../../contributor/plugin-contract with :doc:../../contributor/extending/guides/index and :doc:../../appendices/external_plugins

Plugin contract elevated in contributor hub; extending guides for wiring CLI and config; external plugin index (community plugins) moved to appendices.

pr_guide.md

:doc:../governance/pr_guide and :doc:../governance/section_owners

Governance actions captured under maintainership docs with owners and release narrative under shared foundations.

(new) migration guides

:doc:../../migration/index

Terminology changes, breaking changes, and upgrade guidance captured in a dedicated section linked from all audience hubs.

Audience-first structure verification¶

Per Standard-004, the documentation now follows an audience-led structure:

  • [x] Getting Started appears first in the main toctree (:doc:../../get-started/index``)

  • [x] Practitioner hub includes core workflow (quickstarts → interpretation) and advanced extras (telemetry, performance, PlotSpec)

  • [x] Researcher hub consolidates theory, replication, and benchmarks with equal coverage for classification and regression

  • [x] Contributor hub foregrounds plugin contract and extending guides; defers optional telemetry/performance to advanced section

  • [x] Shared Foundations (concepts, how-to, reference, governance) linked from all audience hubs

  • [x] Appendices & Migration segregated for upgrade guidance and external plugin references

  • [ ] Re-run the gating commands in :doc:release_checklist after updating cross-references

Verification checklist¶

  • [ ] Confirm all pages in the mapping table are added to their respective section toctrees

  • [ ] Ensure deprecated filenames or redirects point readers to the new audience-first paths

  • [ ] Validate that classification and regression parity is maintained across quickstarts and advanced guides

  • [ ] Confirm interpretation guides are linked from every quickstart (classification and regression)

Navigation patterns to maintain¶

When editing audience landing hubs, playbooks, or quickstarts, follow these patterns:

  1. Interpretation-first callouts: All quickstarts (classification and regression) link to :doc:../how-to/interpret_explanations immediately after the runnable code block.

  2. Parity enforcement: Practitioner and researcher pages must provide equivalent coverage for binary/multiclass classification and probabilistic/interval regression.

  3. Research hub references: Audience hubs can point readers to :doc:../../researcher/index in a Resources or Further Reading section to avoid navigation clutter.

  4. Plugin boundaries: Contributor and practitioner docs reference external plugins (fast explanations, shap-lime, etc.) via :doc:../../appendices/external_plugins instead of embedding them in the core workflow.

  5. Cross-link validation: After structural changes, run sphinx-build -b html -W and check for broken cross-references in the build log.

Next
API reference
Previous
Extending guides
Copyright © 2023, Helena Löfström, Tuwe Löfström
Made with Sphinx and @pradyunsg's Furo
Last updated on May 12, 2026
On this page
  • Navigation crosswalk
    • Legacy → New location mapping
    • Audience-first structure verification
    • Verification checklist
    • Navigation patterns to maintain