# alaazaitoon/modern-regression-project architecture

> Architecture diagram of the GitHub repository alaazaitoon/modern-regression-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/alaazaitoon/modern-regression-project
- Repository: https://github.com/alaazaitoon/modern-regression-project

## Overview

Smart Regression is a guided regression-analysis dashboard backed by a FastAPI service; the README says statistical calculations remain on the backend and data/models are held in process memory. The user uploads or enters data, configures and trains a model, explores diagnostics and inference, then generates a report. The graph preserves these stages plus health, recommendations, and PDF export. Backend calls are supported by excerpts and the source index; frontend-to-API and UI workflow links rely on README documentation because most frontend wiring was not excerpted.

Main entry points: [`backend/routers/models.py`](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/models.py) (Model endpoints), [`frontend/lib/api.ts`](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/lib/api.ts) (Typed API client), [`backend/main.py`](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/main.py) (FastAPI application), [`backend/routers/datasets.py`](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/datasets.py) (Dataset endpoints)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Dashboard workflow"]
  node_dashboard["Workflow dashboard<br/>[page.tsx]"]
  node_upload["Dataset entry<br/>[step-upload.tsx]"]
  node_configure["Model setup<br/>[step-configure.tsx]"]
  node_visualize["Diagnostic charts<br/>[step-visualize.tsx]"]
  node_results["Statistical results<br/>[step-results.tsx]"]
  node_recommendations["Recommendations"]
  node_reportui["Report view<br/>[report-client.tsx]"]
  node_client["Typed API client<br/>[api.ts]"]
end

subgraph group_api["API surface"]
  node_main["FastAPI application<br/>[main.py]"]
  node_health["Health endpoint<br/>[health.py]"]
  node_datasets["Dataset endpoints<br/>[datasets.py]"]
  node_models["Model endpoints<br/>[models.py]"]
end

subgraph group_analytics["Analytics services"]
  node_data["CSV profiling<br/>[data_service.py]"]
  node_regression["OLS inference"]
  node_pdf["PDF generation<br/>[report_service.py]"]
end

subgraph group_runtime["Runtime state and contracts"]
  node_datasetstore[("Dataset registry<br/>[state.py]")]
  node_modelstore[("Model registry<br/>[state.py]")]
  node_datasetschema["Dataset contract<br/>[dataset.py]"]
  node_modelschema["Model contract<br/>[model.py]"]
  node_errors["Error handling<br/>[errors.py]"]
end

node_user(("Analyst"))

node_user -->|"uses"| node_dashboard
node_dashboard -->|"starts workflow"| node_upload
node_upload -->|"submits data"| node_client
node_configure -->|"trains model"| node_client
node_client -->|"HTTP requests"| node_main
node_main -->|"mounts route"| node_health
node_main -->|"mounts route"| node_datasets
node_main -->|"mounts route"| node_models
node_datasets -->|"parses and profiles"| node_data
node_datasets -->|"stores and reads"| node_datasetstore
node_data -->|"builds profile"| node_datasetschema
node_models -->|"trains and predicts"| node_regression
node_models -->|"reads dataset"| node_datasetstore
node_models -->|"stores model"| node_modelstore
node_regression -->|"creates results"| node_modelschema
node_models -->|"builds PDF"| node_pdf
node_models -->|"raises domain errors"| node_errors
node_datasets -->|"raises domain errors"| node_errors
node_client -->|"returns model data"| node_visualize
node_client -->|"returns inference"| node_results
node_results -->|"requests suggestions"| node_recommendations
node_user -->|"opens report"| node_reportui
node_reportui -->|"loads report data"| node_client

click node_dashboard "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/app/page.tsx"
click node_upload "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-upload.tsx"
click node_configure "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-configure.tsx"
click node_visualize "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-visualize.tsx"
click node_results "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-results.tsx"
click node_recommendations "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/recommendations/recommendations-panel.tsx"
click node_reportui "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/app/report/report-client.tsx"
click node_client "https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/lib/api.ts"
click node_main "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/main.py"
click node_health "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/health.py"
click node_datasets "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/datasets.py"
click node_models "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/models.py"
click node_data "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/services/data_service.py"
click node_regression "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/services/regression_service.py"
click node_pdf "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/services/report_service.py"
click node_datasetstore "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/state.py"
click node_modelstore "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/state.py"
click node_datasetschema "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/schemas/dataset.py"
click node_modelschema "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/schemas/model.py"
click node_errors "https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/utils/errors.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_dashboard,node_upload,node_configure,node_visualize,node_results,node_recommendations,node_reportui,node_client toneBlue
class node_main,node_health,node_datasets,node_models toneAmber
class node_data,node_regression,node_pdf toneMint
class node_datasetstore,node_modelstore,node_datasetschema,node_modelschema,node_errors toneRose
class node_user toneIndigo
```

## Components

### Dashboard workflow

- [Workflow dashboard](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/app/page.tsx): `frontend/app/page.tsx`
- [Dataset entry](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-upload.tsx): `frontend/components/steps/step-upload.tsx`
- [Model setup](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-configure.tsx): `frontend/components/steps/step-configure.tsx`
- [Diagnostic charts](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-visualize.tsx): `frontend/components/steps/step-visualize.tsx`
- [Statistical results](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/steps/step-results.tsx): `frontend/components/steps/step-results.tsx`
- [Recommendations](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/components/recommendations/recommendations-panel.tsx): `frontend/components/recommendations/recommendations-panel.tsx`
- [Report view](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/app/report/report-client.tsx): `frontend/app/report/report-client.tsx`
- [Typed API client](https://github.com/alaazaitoon/modern-regression-project/blob/main/frontend/lib/api.ts): `frontend/lib/api.ts`

### API surface

- [FastAPI application](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/main.py): `backend/main.py`
- [Health endpoint](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/health.py): `backend/routers/health.py`
- [Dataset endpoints](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/datasets.py): `backend/routers/datasets.py`
- [Model endpoints](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/routers/models.py): `backend/routers/models.py`

### Analytics services

- [CSV profiling](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/services/data_service.py): `backend/services/data_service.py`
- [OLS inference](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/services/regression_service.py): `backend/services/regression_service.py`
- [PDF generation](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/services/report_service.py): `backend/services/report_service.py`

### Runtime state and contracts

- [Dataset registry](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/state.py): `backend/state.py`
- [Model registry](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/state.py): `backend/state.py`
- [Dataset contract](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/schemas/dataset.py): `backend/schemas/dataset.py`
- [Model contract](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/schemas/model.py): `backend/schemas/model.py`
- [Error handling](https://github.com/alaazaitoon/modern-regression-project/blob/main/backend/utils/errors.py): `backend/utils/errors.py`

### Other components

- **Analyst**

## Connections

- Analyst → Workflow dashboard: uses (evidence: `README.md`)
- Workflow dashboard → Dataset entry: starts workflow (evidence: `README.md`)
- Dataset entry → Typed API client: submits data (evidence: `README.md`)
- Model setup → Typed API client: trains model (evidence: `README.md`)
- Typed API client → FastAPI application: HTTP requests (evidence: `README.md`)
- FastAPI application → Health endpoint: mounts route (evidence: `backend/main.py`)
- FastAPI application → Dataset endpoints: mounts route (evidence: `backend/main.py`)
- FastAPI application → Model endpoints: mounts route (evidence: `backend/main.py`)
- Dataset endpoints → CSV profiling: parses and profiles (evidence: `backend/routers/datasets.py`)
- Dataset endpoints → Dataset registry: stores and reads (evidence: `backend/routers/datasets.py`)
- CSV profiling → Dataset contract: builds profile (evidence: `backend/services/data_service.py`)
- Model endpoints → OLS inference: trains and predicts (evidence: `backend/routers/models.py`)
- Model endpoints → Dataset registry: reads dataset (evidence: `backend/routers/models.py`)
- Model endpoints → Model registry: stores model (evidence: `backend/routers/models.py`)
- OLS inference → Model contract: creates results (evidence: `backend/services/regression_service.py`)
- Model endpoints → PDF generation: builds PDF (evidence: `backend/routers/models.py`)
- Model endpoints → Error handling: raises domain errors (evidence: `backend/routers/models.py`)
- Dataset endpoints → Error handling: raises domain errors (evidence: `backend/routers/datasets.py`)
- Typed API client → Diagnostic charts: returns model data (evidence: `README.md`)
- Typed API client → Statistical results: returns inference (evidence: `README.md`)
- Statistical results → Recommendations: requests suggestions (evidence: `README.md`)
- Analyst → Report view: opens report (evidence: `README.md`)
- Report view → Typed API client: loads report data (evidence: `README.md`)
