OCEAN Documentation

OCEAN provides exact counterfactual explanations for tree ensembles through three interchangeable optimization backends: mixed-integer programming, constraint programming, and weighted MaxSAT.

The guide below starts with the common workflow, then goes deeper into data preparation, backend-specific behavior, and worked examples.

User Guide

• Overview
  • What OCEAN expects
  • Supported models
  • Backend summary
  • Common workflow
  • What the explanation object gives back
• Mathematical Model
  • Problem statement
  • Optional isolation-forest constraint
  • Feature domains
  • Tree path variables
  • Ensemble score aggregation
  • Distance objectives
  • Backend realizations
  • Reading the implementation
  • Backend method reference
• Low-level Internals
  • Mapper utilities
  • MIP managers
  • CP managers
  • MaxSAT managers
• Installation
  • Base package
  • Runtime requirements by backend
  • Development install
  • Build the documentation locally
  • Read the Docs configuration
• Quickstart
  • Step-by-step
  • Common variations
  • When to use the next guides
• Visual Examples
  • Continuous 2D Counterfactual
  • Ordinal Discrete 2D Counterfactual
  • How this connects to preprocessing
• Isolation Forest Example
  • How to read the dashed contour
  • Backend comparison
  • Why 0.1 is infeasible
  • Run the example
• Data Preparation
  • Automatic feature typing
  • Cleaning behavior
  • Discrete versus one-hot encoded
  • Example
  • Why the mapper matters
  • Recommended practice
• Explainer Guide
  • Constructor pattern
  • Calling explain
  • Backend-specific behavior
  • Repeated solves
  • Inspecting the result
  • Handling infeasibility and time limits
• Custom Dataset Example
  • Why this example matters
  • Cell 1: Build a mixed-type dataframe
  • Cell 2: Parse the features with OCEAN
  • Cell 3: Fit a classifier and choose a query
  • Cell 4: Explain the query
  • Cell 5: Inspect the decoded explanation
  • Cell 6: Inspect the processed vector and the final distance
  • Full script

API Reference

• API Reference
  • Top-level Package
  • Mapping Utilities
  • Datasets
  • Feature Processing
  • Tree Utilities
  • Constraint Programming Backend
  • Mixed-integer Programming Backend
  • Weighted MaxSAT Backend
  • Shared Typing Helpers