# andrew-canada/flightid architecture

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

- Interactive diagram: https://gitdiagram.com/andrew-canada/flightid
- Repository: https://github.com/andrew-canada/flightid

## Overview

FlightID is a batch airfare-audit pipeline: it turns airline data into fare-per-mile predictions, inflation flags, explanations, alternative destinations, and corridor rankings. The main workflow is implemented in `src/train_explain.py`, with feature engineering and analysis helpers in `src/utils.py`; generated artifacts are written to `outputs/`. The README also describes notebook-based visualizations. Edges reflect the sampled pipeline and documented capabilities; notebook internals were not sampled.

Main entry points: [`src/train_explain.py`](https://github.com/andrew-canada/flightid/blob/main/src/train_explain.py) (Pipeline runner), [`outputs`](https://github.com/andrew-canada/flightid/tree/main/outputs) (Analysis outputs), [`data/airline_ticket_dataset_csv.csv`](https://github.com/andrew-canada/flightid/blob/main/data/airline_ticket_dataset_csv.csv) (Airline dataset), [`notebooks/visuals.ipynb`](https://github.com/andrew-canada/flightid/blob/main/notebooks/visuals.ipynb) (Notebook visualizations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_inputs["Airfare inputs"]
  node_dataset["Airline dataset"]
end

subgraph group_pipeline["Analysis pipeline"]
  node_runner["Pipeline runner<br/>[train_explain.py]"]
  node_engineering["Feature engineering<br/>[utils.py]"]
  node_model["Fare model<br/>[train_explain.py]"]
end

subgraph group_insights["Fare insights"]
  node_shap["SHAP explanation<br/>[utils.py]"]
  node_inflation["Inflation detection<br/>[utils.py]"]
  node_alternatives["Alternative routes<br/>[utils.py]"]
  node_rankings["Corridor rankings<br/>[utils.py]"]
  node_notebook_visuals["Notebook visualizations<br/>[visuals.ipynb]"]
end

subgraph group_results["Reports and artifacts"]
  node_artifacts["Model artifacts"]
  node_reports["Analysis outputs"]
end

node_operator(("Pipeline operator"))

node_operator -->|"runs"| node_runner
node_dataset -->|"loads"| node_runner
node_runner -->|"engineers features"| node_engineering
node_runner -->|"trains"| node_model
node_runner -->|"computes explanations"| node_shap
node_runner -->|"detects inflation"| node_inflation
node_runner -->|"suggests routes"| node_alternatives
node_runner -->|"ranks corridors"| node_rankings
node_model -->|"saves model"| node_artifacts
node_runner -->|"writes reports"| node_reports
node_notebook_visuals -.->|"visualizes results"| node_reports

click node_dataset "https://github.com/andrew-canada/flightid/blob/main/data/airline_ticket_dataset_csv.csv"
click node_runner "https://github.com/andrew-canada/flightid/blob/main/src/train_explain.py"
click node_engineering "https://github.com/andrew-canada/flightid/blob/main/src/utils.py"
click node_model "https://github.com/andrew-canada/flightid/blob/main/src/train_explain.py"
click node_shap "https://github.com/andrew-canada/flightid/blob/main/src/utils.py"
click node_inflation "https://github.com/andrew-canada/flightid/blob/main/src/utils.py"
click node_alternatives "https://github.com/andrew-canada/flightid/blob/main/src/utils.py"
click node_rankings "https://github.com/andrew-canada/flightid/blob/main/src/utils.py"
click node_notebook_visuals "https://github.com/andrew-canada/flightid/blob/main/notebooks/visuals.ipynb"
click node_artifacts "https://github.com/andrew-canada/flightid/tree/main/outputs"
click node_reports "https://github.com/andrew-canada/flightid/tree/main/outputs"

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_dataset toneBlue
class node_runner,node_engineering,node_model toneAmber
class node_shap,node_inflation,node_alternatives,node_rankings,node_notebook_visuals toneMint
class node_artifacts,node_reports toneRose
class node_operator toneIndigo
```

## Components

### Airfare inputs

- [Airline dataset](https://github.com/andrew-canada/flightid/blob/main/data/airline_ticket_dataset_csv.csv): `data/airline_ticket_dataset_csv.csv`

### Analysis pipeline

- [Pipeline runner](https://github.com/andrew-canada/flightid/blob/main/src/train_explain.py): `src/train_explain.py`
- [Feature engineering](https://github.com/andrew-canada/flightid/blob/main/src/utils.py): `src/utils.py`
- [Fare model](https://github.com/andrew-canada/flightid/blob/main/src/train_explain.py): `src/train_explain.py`

### Fare insights

- [SHAP explanation](https://github.com/andrew-canada/flightid/blob/main/src/utils.py): `src/utils.py`
- [Inflation detection](https://github.com/andrew-canada/flightid/blob/main/src/utils.py): `src/utils.py`
- [Alternative routes](https://github.com/andrew-canada/flightid/blob/main/src/utils.py): `src/utils.py`
- [Corridor rankings](https://github.com/andrew-canada/flightid/blob/main/src/utils.py): `src/utils.py`
- [Notebook visualizations](https://github.com/andrew-canada/flightid/blob/main/notebooks/visuals.ipynb): `notebooks/visuals.ipynb`

### Reports and artifacts

- [Model artifacts](https://github.com/andrew-canada/flightid/tree/main/outputs): `outputs`
- [Analysis outputs](https://github.com/andrew-canada/flightid/tree/main/outputs): `outputs`

### Other components

- **Pipeline operator**

## Connections

- Pipeline operator → Pipeline runner: runs (evidence: `README.md`)
- Airline dataset → Pipeline runner: loads (evidence: `src/train_explain.py`)
- Pipeline runner → Feature engineering: engineers features (evidence: `src/train_explain.py`)
- Pipeline runner → Fare model: trains (evidence: `src/train_explain.py`)
- Pipeline runner → SHAP explanation: computes explanations (evidence: `src/train_explain.py`)
- Pipeline runner → Inflation detection: detects inflation (evidence: `src/train_explain.py`)
- Pipeline runner → Alternative routes: suggests routes (evidence: `src/train_explain.py`)
- Pipeline runner → Corridor rankings: ranks corridors (evidence: `src/train_explain.py`)
- Fare model → Model artifacts: saves model (evidence: `src/train_explain.py`)
- Pipeline runner → Analysis outputs: writes reports (evidence: `src/train_explain.py`)
- Notebook visualizations → Analysis outputs: visualizes results (evidence: `README.md`)
