# akashray05/lithology_predictor architecture

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

- Interactive diagram: https://gitdiagram.com/akashray05/lithology_predictor
- Repository: https://github.com/akashray05/lithology_predictor

## Overview

Lithology Predictor is an early-stage well-log classification project. Its README describes a planned workflow from dataset inspection through evaluation and eventual interactive prediction, but explicitly says the ML pipeline and web application are not implemented. The notebooks and split CSV indicate project artifacts; they do not establish runtime connections. Edges below therefore show only the README’s documented planned sequence, not verified calls. The source package currently contains only an empty initializer.

Main entry points: [`notebooks/01_dataset_visualization.ipynb`](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/01_dataset_visualization.ipynb) (Dataset Inspection), [`notebooks/03_preprocessing.ipynb`](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/03_preprocessing.ipynb) (Cleaning and Splitting), [`notebooks/04_feature_engineering.ipynb`](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/04_feature_engineering.ipynb) (Feature Engineering), [`notebooks/06_model_baseline.ipynb`](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/06_model_baseline.ipynb) (Baseline Models)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_data_work["Dataset Work"]
  node_well_log_data[("FORCE Dataset")]
  node_inspection["Dataset Inspection"]
  node_clean_split["Cleaning and Splitting"]
  node_features["Feature Engineering"]
end

subgraph group_model_work["Model Development"]
  node_baseline["Baseline Models"]
  node_final_model["Final Model"]
  node_evaluation["Final Evaluation"]
end

subgraph group_product_work["Planned Prediction App"]
  node_web_app["Prediction App"]
end

node_user(("Well-log User"))

node_well_log_data -.->|"inspect"| node_inspection
node_inspection -.->|"prepare"| node_clean_split
node_clean_split -.->|"engineer"| node_features
node_features -.->|"train"| node_baseline
node_baseline -.->|"select"| node_final_model
node_final_model -.->|"evaluate"| node_evaluation
node_evaluation -.->|"package for"| node_web_app
node_user -.->|"upload logs"| node_web_app

click node_well_log_data "https://github.com/akashray05/lithology_predictor/tree/main/data/raw"
click node_inspection "https://github.com/akashray05/lithology_predictor/blob/main/notebooks/01_dataset_visualization.ipynb"
click node_clean_split "https://github.com/akashray05/lithology_predictor/blob/main/notebooks/03_preprocessing.ipynb"
click node_features "https://github.com/akashray05/lithology_predictor/blob/main/notebooks/04_feature_engineering.ipynb"
click node_baseline "https://github.com/akashray05/lithology_predictor/blob/main/notebooks/06_model_baseline.ipynb"
click node_final_model "https://github.com/akashray05/lithology_predictor/blob/main/notebooks/07_final_model.ipynb"
click node_evaluation "https://github.com/akashray05/lithology_predictor/blob/main/notebooks/08_final_evaluation.ipynb"

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_well_log_data,node_inspection,node_clean_split,node_features,node_user toneBlue
class node_baseline,node_final_model,node_evaluation toneAmber
class node_web_app toneMint
```

## Components

### Dataset Work

- [FORCE Dataset](https://github.com/akashray05/lithology_predictor/tree/main/data/raw): `data/raw`
- [Dataset Inspection](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/01_dataset_visualization.ipynb): `notebooks/01_dataset_visualization.ipynb`
- [Cleaning and Splitting](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/03_preprocessing.ipynb): `notebooks/03_preprocessing.ipynb`
- [Feature Engineering](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/04_feature_engineering.ipynb): `notebooks/04_feature_engineering.ipynb`

### Model Development

- [Baseline Models](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/06_model_baseline.ipynb): `notebooks/06_model_baseline.ipynb`
- [Final Model](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/07_final_model.ipynb): `notebooks/07_final_model.ipynb`
- [Final Evaluation](https://github.com/akashray05/lithology_predictor/blob/main/notebooks/08_final_evaluation.ipynb): `notebooks/08_final_evaluation.ipynb`

### Planned Prediction App

- **Prediction App**

### Other components

- **Well-log User**

## Connections

- FORCE Dataset → Dataset Inspection: inspect (evidence: `README.md`)
- Dataset Inspection → Cleaning and Splitting: prepare (evidence: `README.md`)
- Cleaning and Splitting → Feature Engineering: engineer (evidence: `README.md`)
- Feature Engineering → Baseline Models: train (evidence: `README.md`)
- Baseline Models → Final Model: select (evidence: `README.md`)
- Final Model → Final Evaluation: evaluate (evidence: `README.md`)
- Final Evaluation → Prediction App: package for (evidence: `README.md`)
- Well-log User → Prediction App: upload logs (evidence: `README.md`)
