# nclsprsnw/oasis architecture

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

- Interactive diagram: https://gitdiagram.com/nclsprsnw/oasis
- Repository: https://github.com/nclsprsnw/oasis

## Overview

##### Project type and purpose
- This is a full-stack machine-learning application for real-estate price prediction with a special focus on climatic events.
- It encompasses data ingestion and processing, model training and experiment tracking, an inference API, and a customer-facing web UI.

##### File structure
- data/
- raw/ – unprocessed historical real‐estate and climate data
- processed/ – cleaned and feature‐engineered datasets
- notebooks/ – Jupyter notebooks for EDA, preprocessing, feature engineering, model experimentation
- models/ – serialized model artifacts (pickles, ONNX, etc.)
- mlflow/ – configuration and deployment files for the MLflow tracking server
- api/ – Python code (e.g. FastAPI + Uvicorn) exposing a prediction endpoint
- web/ – frontend code (e.g. React/Vue/HTML+CSS+JS) that consumes the API
- requirements.txt – project dependencies
- docs/ – images and documentation
- CONTRIBUTING.md / README.md – guidelines and project overview

##### README insights
- MLflow is used to track experiments, log metrics, parameters, and register production models.
- The API is the inference gateway; the web app interacts with it to show predictions.
- Future plans include additional event types and expanded data pipelines.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Data Layer
    subgraph "Data Layer"
        direction TB
        ExtSources["External Data Sources\n(Weather APIs, Real-Estate Feeds)"]:::data
        RawData[(Raw Data)]:::data
        ProcessedData[(Processed Data)]:::data
    end

    ExtSources -->|ingest| RawData
    RawData -->|clean & feature-engineer| ProcessedData

    %% Training Layer
    subgraph "Training Layer"
        direction TB
        Notebooks["Feature Engineering & Training\n(Notebooks & Scripts)"]:::compute
        TrainingJobs["Training Jobs"]:::compute
    end

    ProcessedData -->|feed into| Notebooks
    Notebooks -->|execute| TrainingJobs

    %% Tracking Layer
    subgraph "Tracking Layer"
        direction TB
        MLflowServer["MLflow Tracking Server"]:::compute
        ExperimentDB[(Experiment DB)]:::data
        ModelRegistry[(Model Registry)]:::data
    end

    TrainingJobs -->|log runs| MLflowServer
    MLflowServer -->|store metrics| ExperimentDB
    MLflowServer -->|register models| ModelRegistry

    %% Model Store
    subgraph "Model Artifact Store"
        direction TB
        ModelStore[(Serialized Models)]:::data
    end

    TrainingJobs -->|save artifacts| ModelStore

    %% Serving Layer
    subgraph "Serving Layer"
        direction TB
        PredictionAPI["Prediction Service\n(FastAPI/Uvicorn)"]:::serving
    end

    ModelRegistry -->|load model| PredictionAPI
    ModelStore -->|load model| PredictionAPI

    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        WebApp["Web Application\n(React/Vue/JS)"]:::ui
    end

    WebApp -->|HTTP request| PredictionAPI
    PredictionAPI -->|prediction response| WebApp

    %% Project Artifacts
    subgraph "Project Artifacts"
        direction TB
        Requirements["requirements.txt"]:::docs
        Docs["Documentation & Diagrams\n(docs/)"]:::docs
        README["README.md"]:::docs
        Contributing["CONTRIBUTING.md"]:::docs
    end

    %% Click Events
    click RawData "https://github.com/nclsprsnw/oasis/tree/main/data/raw/"
    click ProcessedData "https://github.com/nclsprsnw/oasis/tree/main/data/processed/"
    click Notebooks "https://github.com/nclsprsnw/oasis/tree/main/notebooks/"
    click MLflowServer "https://github.com/nclsprsnw/oasis/tree/main/mlflow/"
    click ModelStore "https://github.com/nclsprsnw/oasis/tree/main/models/"
    click PredictionAPI "https://github.com/nclsprsnw/oasis/tree/main/api/"
    click WebApp "https://github.com/nclsprsnw/oasis/tree/main/web/"
    click Requirements "https://github.com/nclsprsnw/oasis/blob/main/requirements.txt"
    click Docs "https://github.com/nclsprsnw/oasis/tree/main/docs/"
    click README "https://github.com/nclsprsnw/oasis/blob/main/README.md"
    click Contributing "https://github.com/nclsprsnw/oasis/blob/main/CONTRIBUTING.md"

    %% Styles
    classDef data fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef compute fill:#98FB98,stroke:#333,stroke-width:1px
    classDef serving fill:#FFA500,stroke:#333,stroke-width:1px
    classDef ui fill:#DDA0DD,stroke:#333,stroke-width:1px
    classDef docs fill:#D3D3D3,stroke:#333,stroke-width:1px
```
