# vinz7540/python-project-2 architecture

> Architecture diagram of the GitHub repository vinz7540/python-project-2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vinz7540/python-project-2
- Repository: https://github.com/vinz7540/python-project-2

## Overview

##### Project type and purpose
- From the README (“Predicting Customer Churn in Telecom Company”) and the presence of a single Jupyter notebook, this is a machine-learning prototype / data-science project focused on churn-prediction.
- It is not yet a full-stack application but rather an exploratory notebook that ingests data, engineers features, trains models, and evaluates performance.

##### File structure
- Top-level items:
- .gitignore – standard ignore rules
- PROJECT 3-CAPSTONE.ipynb – the central analysis, modeling, and evaluation notebook
- README.md – high-level project description
- No separate directories for data, scripts, or deployment; everything lives inside the notebook. This suggests the need to modularize before formalizing architecture.

##### Additional insights from the README
- No explicit architecture described. The narrative is purely “predicting customer churn,” so we will need to infer the standard ML pipeline and propose how to break it into components.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Data Sources and Storage
    DataSource["Data Source (CSV/SQL/Cloud)"]:::dataStore
    RawStore["Raw Data Store (S3/Postgres)"]:::dataStore
    FeatureStore["Feature Store (Parquet/Feast)"]:::dataStore
    ModelRegistry["Model Registry (MLflow/DVC)"]:::dataStore

    %% Processing Jobs
    subgraph "ML Pipeline"
        direction TB
        Ingestion["Data Ingestion Job"]:::processing
        FeatureEng["Feature Engineering Job"]:::processing
        ModelTrain["Model Training Job"]:::processing
    end

    %% Serving and User Interfaces
    ServeAPI["Model Serving API (FastAPI/Flask)"]:::service
    Dashboard["Dashboard / Reporting (Streamlit/Dash)"]:::service

    %% Orchestration & Monitoring
    Orchestration["Orchestration (Airflow/Prefect)"]:::process
    Monitoring["Monitoring & Feedback"]:::service

    %% DevOps and Code Artefacts
    GitIgnore[".gitignore"]:::config
    Readme["README.md"]:::config
    Notebook["PROJECT 3-CAPSTONE.ipynb"]:::config

    %% Relationships
    DataSource -->|batch read| Ingestion
    Ingestion -->|writes raw data| RawStore
    RawStore -->|reads raw data| FeatureEng
    FeatureEng -->|writes features| FeatureStore
    FeatureStore -->|reads features| ModelTrain
    ModelTrain -->|registers model| ModelRegistry
    ModelRegistry -->|loads model| ServeAPI
    ServeAPI -->|REST predict| Dashboard
    Orchestration -->|triggers| Ingestion
    Orchestration -->|triggers| FeatureEng
    Orchestration -->|triggers| ModelTrain
    ServeAPI -->|logs predictions| Monitoring
    Monitoring -->|feedback| FeatureEng

    %% DevOps Links
    GitIgnore --> Notebook
    Readme --> Notebook

    %% Click Events
    click Notebook "https://github.com/vinz7540/python-project-2/blob/main/PROJECT 3-CAPSTONE.ipynb"
    click Readme "https://github.com/vinz7540/python-project-2/blob/main/README.md"
    click GitIgnore "https://github.com/vinz7540/python-project-2/blob/main/.gitignore"

    %% Styles
    classDef dataStore fill:#CCE5FF,stroke:#0066CC,color:#003366;
    classDef processing fill:#DFF2BF,stroke:#4F8A10,color:#4F8A10;
    classDef service fill:#F5E6CC,stroke:#CC7A00,color:#663300;
    classDef process fill:#EFD6D3,stroke:#D46A6A,color:#A41E22;
    classDef config fill:#E2E3E5,stroke:#A0A0A5,color:#333333;
```
