# teddylee777/machine-learning architecture

> Architecture diagram of the GitHub repository teddylee777/machine-learning, 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/teddylee777/machine-learning
- Repository: https://github.com/teddylee777/machine-learning

## Overview

##### Project Type and Purpose
- This is an open-source “Machine Learning Study” monorepo: a content-centric repository of Jupyter notebooks, tutorials, sample data, and scripts organized by topic (Python basics, Kaggle exercises, PyTorch, TensorFlow, Pandas, Visualization, Scikit-Learn, XAI, GAN, RL, AutoML, HuggingFace, ChatGPT, Misc). Its purpose is to serve as a self-study resource and reference for machine-learning practitioners.

##### File Structure Analysis
- Top-level directories each correspond to a major topic or framework (e.g., “00-Python”, “01-Kaggle”, “02-PyTorch”, …).
- Within each topic folder:
- core notebooks (.ipynb files)
- subfolders for tutorial basics, exercises (“실습”), solutions (“해설”), sample data (“data”), scripts (e.g., sample_dataset.py)
- Configuration files at root: README.md (table of contents and links), requirements.txt (global Python dependencies), .gitignore, CONTRIBUTING.md

##### README Insights
- Acts as the system’s landing page and content directory, listing contributors, external learning resources (videos, blogs), and grouping topics by subject.
- No runtime web-server or CI/CD pipelines—focus is on Git-based content delivery and local notebook execution.

a. Main Components
- GitHub Repository (monorepo of content modules)
- Developer Workstation / Local Clone
- Runtime Environment:
– Jupyter Notebook Server / Lab
– Python Interpreter + Virtual Environment (venv or Conda)
– Dependencies loaded from requirements.txt (PyTorch, TensorFlow, scikit-learn, pandas, matplotlib, etc.)
- Data Sources:
– Local CSV/data files under each module’s data folder
– External datasets (Kaggle API, public data portals)
- Outputs:
– Notebook outputs (plots, metrics)
– HTML exports or static site (if used)
- External Resources (optional):
– Video lectures, blog links, GitHub Pages for tutorials

b. Relationships and Data Flow
1. Developer pulls/clones the GitHub Repository →
2. Creates/activates Python environment and installs requirements →
3. Launches Jupyter Notebook Server pointing at the cloned workspace →
4. Notebook code cells read local data or fetch from external sources →
5. Notebook invokes Python libraries (PyTorch, TensorFlow, etc.) to run examples →
6. Results (visualizations, model checkpoints) appear inline or are saved locally →
7. Changes (new notebooks, updates) are committed back to GitHub

c. Architectural Patterns and Design Principles
- Monorepo pattern: single Git repository hosting multiple topical modules
- Modular separation by domain: each directory encapsulates its own tutorials, data, and dependencies
- Content delivery via Git + Jupyter, no dedicated backend or microservices
- Environment reproducibility via requirements.txt (optionally containerized with Docker)

d. Key Technologies and Frameworks
- Version control: Git/GitHub
- Interactive environment: Jupyter Notebook / JupyterLab
- Language/runtime: Python 3.x
- ML libraries: PyTorch, TensorFlow (1.x and 2.0), scikit-learn, PyCaret, AutoKeras, HuggingFace transformers, etc.
- Data handling: pandas, numpy
- Visualization: matplotlib, seaborn, Bokeh, folium
- Optional containerization: Docker with a prebuilt image (deepko)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Repository & Version Control
    Repo["GitHub Repository (Monorepo Root)"]:::repo
    README["System Landing Page\n(README.md)"]:::repo
    Req["Global Dependencies\n(requirements.txt)"]:::repo
    Contrib["Contribution Guidelines\n(CONTRIBUTING.md)"]:::repo

    Repo --> README
    Repo --> Req
    Repo --> Contrib

    %% Developer Workstation
    Dev["Developer Workstation\n(Local Clone)"]:::env
    Repo -->|"git clone"| Dev

    %% Environment Setup
    Env["Python Environment\n(venv/Conda)\n+ Dependencies"]:::env
    Dev -->|"install -r requirements.txt"| Env

    %% Interactive Server
    Jupyter["Jupyter Notebook Server"]:::env
    Env -->|"launch notebook"| Jupyter

    %% Content Modules Group
    subgraph "Content Modules" 
        direction TB
        M00["Module: 00-Python"]:::module
        M01["Module: 01-Kaggle"]:::module
        M02["Module: 02-PyTorch"]:::module
        M03["Module: 03-TensorFlow"]:::module
        M04["Module: 04-TensorFlow2.0"]:::module
        M05["Module: 05-Pandas"]:::module
        M06["Module: 06-Visualization"]:::module
        M07["Module: 07-Scikit-Learn"]:::module
        M08["Module: 08-XAI"]:::module
        M09["Module: 09-GAN"]:::module
        M10["Module: 10-RL"]:::module
        M11["Module: 11-AutoML"]:::module
        M12["Module: 12-HuggingFace"]:::module
        M13["Module: 13-ChatGPT"]:::module
        M99["Module: 99-Misc"]:::module
    end

    Jupyter -->|"open notebooks"| M00
    Jupyter --> M01
    Jupyter --> M02
    Jupyter --> M03
    Jupyter --> M04
    Jupyter --> M05
    Jupyter --> M06
    Jupyter --> M07
    Jupyter --> M08
    Jupyter --> M09
    Jupyter --> M10
    Jupyter --> M11
    Jupyter --> M12
    Jupyter --> M13
    Jupyter --> M99

    %% Data Sources
    subgraph "Data Sources" 
        direction TB
        LocalData["Local CSV/Data Files"]:::data
        ExternalData["External Datasets\n(Kaggle API, Public)"]:::data
    end

    M00 --> LocalData
    M04 --> LocalData
    Jupyter --> ExternalData

    %% Libraries
    subgraph "ML Libraries & Tools"
        direction TB
        PyTorch["PyTorch"]:::lib
        TensorFlow["TensorFlow"]:::lib
        Sklearn["scikit-learn"]:::lib
        Pandas["pandas, numpy"]:::lib
        Viz["matplotlib, seaborn, Bokeh"]:::lib
        HF["HuggingFace Transformers"]:::lib
        AutoML["AutoKeras, PyCaret"]:::lib
    end

    Jupyter --> PyTorch
    Jupyter --> TensorFlow
    Jupyter --> Sklearn
    Jupyter --> Pandas
    Jupyter --> Viz
    Jupyter --> HF
    Jupyter --> AutoML

    %% Outputs
    subgraph "Outputs & Publishing"
        direction TB
        Outputs["Notebook Outputs\n(plots, metrics, checkpoints)"]:::output
        HTML["HTML Exports\n/Static Site"]:::output
        GitPush["Commit & Push Changes"]:::output
    end

    Jupyter --> Outputs
    Outputs --> HTML
    Dev --> GitPush
    GitPush --> Repo

    %% External Resources
    Ext["External Learning Resources\n(videos, blogs)"]:::external
    HTML --> Ext

    %% Click Events
    click Repo "https://github.com/teddylee777/machine-learning/tree/master//"
    click README "https://github.com/teddylee777/machine-learning/blob/master//README.md"
    click Req "https://github.com/teddylee777/machine-learning/blob/master//requirements.txt"
    click Contrib "https://github.com/teddylee777/machine-learning/blob/master//CONTRIBUTING.md"
    click M00 "https://github.com/teddylee777/machine-learning/tree/master//00-Python"
    click M01 "https://github.com/teddylee777/machine-learning/tree/master//01-Kaggle"
    click M02 "https://github.com/teddylee777/machine-learning/tree/master//02-PyTorch"
    click M03 "https://github.com/teddylee777/machine-learning/tree/master//03-TensorFlow"
    click M04 "https://github.com/teddylee777/machine-learning/blob/master//04-TensorFlow2.0"
    click M05 "https://github.com/teddylee777/machine-learning/tree/master//05-Pandas"
    click M06 "https://github.com/teddylee777/machine-learning/tree/master//06-Visualization"
    click M07 "https://github.com/teddylee777/machine-learning/tree/master//07-Scikit-Learn"
    click M08 "https://github.com/teddylee777/machine-learning/tree/master//08-XAI"
    click M09 "https://github.com/teddylee777/machine-learning/tree/master//09-GAN"
    click M10 "https://github.com/teddylee777/machine-learning/tree/master//10-RL"
    click M11 "https://github.com/teddylee777/machine-learning/tree/master//11-AutoML"
    click M12 "https://github.com/teddylee777/machine-learning/tree/master//12-HuggingFace"
    click M13 "https://github.com/teddylee777/machine-learning/tree/master//13-ChatGPT"
    click M99 "https://github.com/teddylee777/machine-learning/tree/master//99-Misc"
    click M00 "https://github.com/teddylee777/machine-learning/blob/master//00-Python/README.md"
    click M02 "https://github.com/teddylee777/machine-learning/blob/master//02-PyTorch/sample_dataset.py"
    click M04 "https://github.com/teddylee777/machine-learning/tree/master//04-TensorFlow2.0/01-삼성전자-주가예측/data/"
    click M11 "https://github.com/teddylee777/machine-learning/blob/master//11-AutoML/requirements.txt"

    %% Styles
    classDef repo fill:#AED6F1,stroke:#1F618D,color:#1B4F72
    classDef env fill:#ABEBC6,stroke:#239B56,color:#1D8348
    classDef module fill:#F9E79F,stroke:#B7950B,color:#7D6608
    classDef data fill:#F5CBA7,stroke:#D35400,color:#873600
    classDef lib fill:#D2B4DE,stroke:#8E44AD,color:#5B2C6F
    classDef output fill:#D6EAF8,stroke:#5DADE2,color:#21618C
    classDef external fill:#F2F3F4,stroke:#AAAAAA,color:#666666
```
