# mitchellkeegan/accel-oct architecture

> Architecture diagram of the GitHub repository mitchellkeegan/accel-oct, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mitchellkeegan/accel-oct
- Repository: https://github.com/mitchellkeegan/accel-oct

## Overview

This is research software for training optimal classification trees with integer programming and producing the paper’s experimental results. The main workflow is to configure and run an OCT model, prepare encoded data, build and optimize a MIP, then log and post-process outcomes into tables and figures. The graph preserves the documented model families and acceleration options, including cuts, callbacks, EQP sets, and solution polishing. Some subsystem links are limited to README statements and SOURCE INDEX references; unsampled implementation details are not inferred.

Main entry points: [`src/models/base_classes.py`](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/base_classes.py) (OCT framework), [`Scripts/RunOCT.py`](https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/RunOCT.py) (Run interface), [`src/models/BendOCT.py`](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendOCT.py) (Bend OCT), [`src/models/BendRegOCT.py`](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendRegOCT.py) (Regularized Bend)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Experiment entry"]
  node_cli["Run interface<br/>[RunOCT.py]"]
  node_dictapi["Dictionary interface"]
end

subgraph group_models["OCT models"]
  node_bend["Bend OCT<br/>[BendOCT.py]"]
  node_bendreg["Regularized Bend<br/>[BendRegOCT.py]"]
  node_bendworst["Worst-case Bend<br/>[BendWorstOCT.py]"]
  node_flow["Flow OCT<br/>[FlowOCT.py]"]
  node_flowreg["Regularized Flow<br/>[FlowRegOCT.py]"]
  node_framework["OCT framework<br/>[base_classes.py]"]
end

subgraph group_acceleration["Model acceleration"]
  node_cuts_callbacks["Cuts and callbacks<br/>[BendOCT.py]"]
  node_reg_cuts_callbacks["Regularized cuts and callbacks<br/>[BendRegOCT.py]"]
  node_worst_callbacks["Path-bound callbacks<br/>[BendWorstOCT.py]"]
  node_eqp["EQP set generation<br/>[generators.py]"]
end

subgraph group_support["Data and runtime support"]
  node_data["Dataset loading<br/>[data.py]"]
  node_tree_utils["Tree routines<br/>[trees.py]"]
  node_pareto["Pareto filtering<br/>[ParetoSets.py]"]
  node_logging["Run logging<br/>[logging.py]"]
end

subgraph group_results["Result analysis"]
  node_postprocess["Result processing<br/>[CreateTables.py]"]
  node_aggregates["Aggregate tables<br/>[CreateAggTable.py]"]
  node_figures["Benchmark figures<br/>[BenchmarkFigure.py]"]
  node_tables["Benchmark tables<br/>[BenchmarkTable.py]"]
end

node_researcher(("Researcher"))
node_mip["MIP solver"]

node_researcher -->|"runs"| node_cli
node_cli -->|"wraps"| node_dictapi
node_cli -->|"loads data"| node_data
node_cli -->|"configures"| node_bend
node_cli -->|"configures"| node_bendreg
node_cli -->|"configures"| node_flowreg
node_dictapi -->|"selects model"| node_bend
node_dictapi -->|"selects model"| node_bendreg
node_dictapi -->|"selects model"| node_flowreg
node_bend -->|"inherits"| node_framework
node_bendreg -->|"inherits"| node_framework
node_bendworst -->|"inherits"| node_framework
node_flow -->|"inherits"| node_framework
node_flowreg -->|"inherits"| node_framework
node_framework -->|"optimizes"| node_mip
node_framework -->|"configures"| node_cuts_callbacks
node_framework -->|"configures"| node_reg_cuts_callbacks
node_framework -.->|"configures"| node_worst_callbacks
node_bend -->|"uses"| node_tree_utils
node_bend -->|"uses"| node_eqp
node_bendreg -->|"uses"| node_tree_utils
node_bendreg -->|"uses"| node_eqp
node_bendworst -->|"uses"| node_tree_utils
node_flow -->|"uses"| node_tree_utils
node_flowreg -->|"uses"| node_tree_utils
node_eqp -.->|"filters sets"| node_pareto
node_bend -->|"logs"| node_logging
node_bendreg -->|"logs"| node_logging
node_bendworst -->|"logs"| node_logging
node_flow -->|"logs"| node_logging
node_flowreg -->|"logs"| node_logging
node_postprocess -->|"reads"| node_data
node_aggregates -->|"reads"| node_data
node_figures -->|"reads"| node_data
node_tables -->|"reads"| node_data

click node_cli "https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/RunOCT.py"
click node_dictapi "https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/OCTDictInterface.py"
click node_data "https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/data.py"
click node_bend "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendOCT.py"
click node_bendreg "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendRegOCT.py"
click node_bendworst "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendWorstOCT.py"
click node_flow "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/FlowOCT.py"
click node_flowreg "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/FlowRegOCT.py"
click node_framework "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/base_classes.py"
click node_cuts_callbacks "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendOCT.py"
click node_reg_cuts_callbacks "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendRegOCT.py"
click node_worst_callbacks "https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendWorstOCT.py"
click node_eqp "https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/generators.py"
click node_tree_utils "https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/trees.py"
click node_pareto "https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/ParetoSets.py"
click node_logging "https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/logging.py"
click node_postprocess "https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/CreateTables.py"
click node_aggregates "https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/CreateAggTable.py"
click node_figures "https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/BenchmarkFigure.py"
click node_tables "https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/BenchmarkTable.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_dictapi toneBlue
class node_bend,node_bendreg,node_bendworst,node_flow,node_flowreg,node_framework toneAmber
class node_cuts_callbacks,node_reg_cuts_callbacks,node_worst_callbacks,node_eqp toneMint
class node_data,node_tree_utils,node_pareto,node_logging toneRose
class node_postprocess,node_aggregates,node_figures,node_tables,node_researcher,node_mip toneIndigo
```

## Components

### Experiment entry

- [Run interface](https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/RunOCT.py): `Scripts/RunOCT.py`
- [Dictionary interface](https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/OCTDictInterface.py): `Scripts/OCTDictInterface.py`

### OCT models

- [Bend OCT](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendOCT.py): `src/models/BendOCT.py`
- [Regularized Bend](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendRegOCT.py): `src/models/BendRegOCT.py`
- [Worst-case Bend](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendWorstOCT.py): `src/models/BendWorstOCT.py`
- [Flow OCT](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/FlowOCT.py): `src/models/FlowOCT.py`
- [Regularized Flow](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/FlowRegOCT.py): `src/models/FlowRegOCT.py`
- [OCT framework](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/base_classes.py): `src/models/base_classes.py`

### Model acceleration

- [Cuts and callbacks](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendOCT.py): `src/models/BendOCT.py`
- [Regularized cuts and callbacks](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendRegOCT.py): `src/models/BendRegOCT.py`
- [Path-bound callbacks](https://github.com/mitchellkeegan/accel-oct/blob/main/src/models/BendWorstOCT.py): `src/models/BendWorstOCT.py`
- [EQP set generation](https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/generators.py): `src/utils/generators.py`

### Data and runtime support

- [Dataset loading](https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/data.py): `src/utils/data.py`
- [Tree routines](https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/trees.py): `src/utils/trees.py`
- [Pareto filtering](https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/ParetoSets.py): `src/utils/ParetoSets.py`
- [Run logging](https://github.com/mitchellkeegan/accel-oct/blob/main/src/utils/logging.py): `src/utils/logging.py`

### Result analysis

- [Result processing](https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/CreateTables.py): `Scripts/ResultsProcessing/CreateTables.py`
- [Aggregate tables](https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/CreateAggTable.py): `Scripts/ResultsProcessing/CreateAggTable.py`
- [Benchmark figures](https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/BenchmarkFigure.py): `Scripts/ResultsProcessing/BenchmarkFigure.py`
- [Benchmark tables](https://github.com/mitchellkeegan/accel-oct/blob/main/Scripts/ResultsProcessing/BenchmarkTable.py): `Scripts/ResultsProcessing/BenchmarkTable.py`

### Other components

- **Researcher**
- **MIP solver**

## Connections

- Researcher → Run interface: runs
- Run interface → Dictionary interface: wraps
- Run interface → Dataset loading: loads data (evidence: `Scripts/RunOCT.py`)
- Run interface → Bend OCT: configures (evidence: `Scripts/RunOCT.py`)
- Run interface → Regularized Bend: configures (evidence: `Scripts/RunOCT.py`)
- Run interface → Regularized Flow: configures (evidence: `Scripts/RunOCT.py`)
- Dictionary interface → Bend OCT: selects model (evidence: `Scripts/OCTDictInterface.py`)
- Dictionary interface → Regularized Bend: selects model (evidence: `Scripts/OCTDictInterface.py`)
- Dictionary interface → Regularized Flow: selects model (evidence: `Scripts/OCTDictInterface.py`)
- Bend OCT → OCT framework: inherits (evidence: `src/models/BendOCT.py`)
- Regularized Bend → OCT framework: inherits (evidence: `src/models/BendRegOCT.py`)
- Worst-case Bend → OCT framework: inherits (evidence: `src/models/BendWorstOCT.py`)
- Flow OCT → OCT framework: inherits (evidence: `src/models/FlowOCT.py`)
- Regularized Flow → OCT framework: inherits (evidence: `src/models/FlowRegOCT.py`)
- OCT framework → MIP solver: optimizes
- OCT framework → Cuts and callbacks: configures (evidence: `src/models/BendOCT.py`)
- OCT framework → Regularized cuts and callbacks: configures (evidence: `src/models/BendRegOCT.py`)
- OCT framework → Path-bound callbacks: configures (evidence: `src/models/BendWorstOCT.py`)
- Bend OCT → Tree routines: uses (evidence: `src/models/BendOCT.py`)
- Bend OCT → EQP set generation: uses (evidence: `src/models/BendOCT.py`)
- Regularized Bend → Tree routines: uses (evidence: `src/models/BendRegOCT.py`)
- Regularized Bend → EQP set generation: uses (evidence: `src/models/BendRegOCT.py`)
- Worst-case Bend → Tree routines: uses (evidence: `src/models/BendWorstOCT.py`)
- Flow OCT → Tree routines: uses (evidence: `src/models/FlowOCT.py`)
- Regularized Flow → Tree routines: uses (evidence: `src/models/FlowRegOCT.py`)
- EQP set generation → Pareto filtering: filters sets
- Bend OCT → Run logging: logs (evidence: `src/models/BendOCT.py`)
- Regularized Bend → Run logging: logs (evidence: `src/models/BendRegOCT.py`)
- Worst-case Bend → Run logging: logs (evidence: `src/models/BendWorstOCT.py`)
- Flow OCT → Run logging: logs (evidence: `src/models/FlowOCT.py`)
- Regularized Flow → Run logging: logs (evidence: `src/models/FlowRegOCT.py`)
- Result processing → Dataset loading: reads (evidence: `Scripts/ResultsProcessing/CreateTables.py`)
- Aggregate tables → Dataset loading: reads (evidence: `Scripts/ResultsProcessing/CreateAggTable.py`)
- Benchmark figures → Dataset loading: reads (evidence: `Scripts/ResultsProcessing/BenchmarkFigure.py`)
- Benchmark tables → Dataset loading: reads (evidence: `Scripts/ResultsProcessing/BenchmarkTable.py`)
