# aghbit/bit_ai architecture

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

- Interactive diagram: https://gitdiagram.com/aghbit/bit_ai
- Repository: https://github.com/aghbit/bit_ai

## Overview

##### Project Type and Purpose
- This repo is an **educational content** repository—specifically, a sequence of Jupyter notebooks teaching introductory Machine Learning topics.
- There is no deployed service; instead, the “system” consists of content modules, data files, and the user’s computing environment (Jupyter/Python with common ML libraries).

##### File Structure
- Top-level directories (modules) follow a numeric progression:
– 0.basics
– 1.python
– 2a.numpy, 2b.matplot, 2c.pandas
– 3.sgd
– 4.logistic_regression, 4.neural_network
– 7.tensorflow_keras
– NLP
- Each module contains one or more `.ipynb` notebooks (and in the pandas module a `housing.csv` data file).
- The README points to a tutorial in `0.basics/` and uses Jupyter Notebooks as the primary delivery mechanism.

##### README for Additional Insights
- Purpose: an introductory ML course covering math, Scikit-Learn, PyTorch, TensorFlow.
- Getting started: run the tutorial in `0.basics` using Jupyter.

##### Main Components & Their Relationships
a. **User Environment**
– Python interpreter + Jupyter Notebook server
– Installed ML libraries: NumPy, Matplotlib, Pandas, Scikit-Learn, TensorFlow, PyTorch
b. **Content Modules** (progression)
– Core modules: 0.basics → 1.python → 2a/2b/2c → 3.sgd → 4.logistic_regression → 4.neural_network → 7.tensorflow_keras → NLP
c. **Data Assets**
– housing.csv (used in pandas module)
d. **External Services / Links**
– Presentation URL for basics module (hosted on GitHub Pages)

Relationships:
– The **User Environment** loads each notebook from the Content Modules.
– Notebooks import and invoke functions from installed ML libraries.
– The pandas notebook ingests the CSV data file.
– The tutorial link in README points users back into the “0.basics” module.

##### Architectural Patterns & Design Principles
- **Linear learning path**—modules are sequential, building complexity.
- **Content‐library integration**—notebooks act as lightweight “presentation + code” components that leverage external libraries rather than in-repo libraries.
- **Modular structure**—each topic in its own folder, allowing future extension or branching (e.g., adding more NLP modules).

## Diagram (Mermaid)

```mermaid
flowchart TD
    UserEnv["Jupyter+Python env w/ ML libs"]:::env

    subgraph "Content Modules"
        M0["0.basics: basics.ipynb"]:::module
        M1["1.python: python.ipynb"]:::module
        M2a["2a.numpy: numpy.ipynb"]:::module
        M2b["2b.matplot: matplotlib.ipynb"]:::module
        M2c["2c.pandas: pandas.ipynb"]:::module
        M3["3.sgd: sgd.ipynb"]:::module
        M4l["4.logistic_regression: logistic_regression.ipynb"]:::module
        M4n["4.neural_network: perceptron.ipynb"]:::module
        M7["7.tensorflow_keras: tf_keras.ipynb"]:::module
        MNLP["NLP: nlp-v0.ipynb"]:::module
    end

    Housing["housing.csv"]:::data
    extLink["Presentation URL"]:::external

    UserEnv -->|executes| M0
    UserEnv -->|executes| M1
    UserEnv -->|executes| M2a
    UserEnv -->|executes| M2b
    UserEnv -->|executes| M2c
    UserEnv -->|executes| M3
    UserEnv -->|executes| M4l
    UserEnv -->|executes| M4n
    UserEnv -->|executes| M7
    UserEnv -->|executes| MNLP

    M2c -->|loads housing.csv| Housing
    M0 -->|links to tutorial HTML| extLink

    M2a -->|"imports NumPy"| Num
    M2b -->|"imports Matplotlib"| Mat
    M2c -->|"imports Pandas"| Pand
    M1 -->|"imports Python libs"| Sk
    M3 -->|"imports Scikit-Learn"| Sk
    M4l -->|"imports Scikit-Learn"| Sk
    M4n -->|"imports NumPy"| Num
    M4n -->|"imports Scikit-Learn"| Sk
    M7 -->|"imports TensorFlow"| TF
    M7 -->|"imports PyTorch"| PT
    MNLP -->|"imports TensorFlow"| TF
    MNLP -->|"imports PyTorch"| PT

    Num["NumPy"]:::lib
    Mat["Matplotlib"]:::lib
    Pand["Pandas"]:::lib
    Sk["Scikit-Learn"]:::lib
    TF["TensorFlow"]:::lib
    PT["PyTorch"]:::lib

    click UserEnv "https://github.com/aghbit/bit_ai/blob/2019_2020/README.md"
    click M0 "https://github.com/aghbit/bit_ai/tree/2019_2020/0.basics/"
    click M1 "https://github.com/aghbit/bit_ai/tree/2019_2020/1. python/"
    click M2a "https://github.com/aghbit/bit_ai/tree/2019_2020/2a.numpy/"
    click M2b "https://github.com/aghbit/bit_ai/tree/2019_2020/2b.matplot/"
    click M2c "https://github.com/aghbit/bit_ai/tree/2019_2020/2c.pandas/"
    click M3 "https://github.com/aghbit/bit_ai/tree/2019_2020/3.sgd/"
    click M4l "https://github.com/aghbit/bit_ai/tree/2019_2020/4.logistic_regression/"
    click M4n "https://github.com/aghbit/bit_ai/tree/2019_2020/4.neural_network/"
    click M7 "https://github.com/aghbit/bit_ai/tree/2019_2020/7.tensorflow_keras/"
    click MNLP "https://github.com/aghbit/bit_ai/tree/2019_2020/NLP/"
    click Housing "https://github.com/aghbit/bit_ai/blob/2019_2020/2c.pandas/housing.csv"

    classDef module fill:#cce5ff,stroke:#3399ff,color:#000
    classDef env fill:#d4edda,stroke:#28a745,color:#000
    classDef lib fill:#d4edda,stroke:#28a745,color:#000
    classDef data fill:#ffe5b4,stroke:#ff9933,color:#000
    classDef external fill:#e2e3e5,stroke:#6c757d,color:#000
```
