# fafa-dl/lhy_machine_learning architecture

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

- Interactive diagram: https://gitdiagram.com/fafa-dl/lhy_machine_learning
- Repository: https://github.com/fafa-dl/lhy_machine_learning

## Overview

##### Project type and purpose
- This is not a running application or service, but a **static educational‐materials repository** for 李宏毅’s Spring Machine Learning courses (2021, 2022, 2023).
- It contains year‐based directories (“2021 ML”, “2022 ML”, “2023 ML”), each subdivided by lecture topic, with Jupyter notebooks, PDFs, raw data (CSV), slide decks, and links to external platforms (Colab, Bilibili, Kaggle).
- The root README ties everything together, exposing links to videos, slides, assignments, and community channels.

##### File structure
- Top‐level:
- Three year folders (“2021 ML”, “2022 ML”, “2023 ML”)
- A root README.md
- Under each year:
- Folders named by lecture week or topic (“01 Introduction”, “02 Deep Learning”, … for 2021; similar naming for 2022/2023).
- Inside each topic: materials (e.g., `.ipynb`, `.pdf`), subfolders for assignments (“作业HWx”), sample code by TAs (“助教作业范例”).
- No code-build scripts, server‐side logic, or microservices—purely content.

##### Key insights from the README
- Points at external services:
- Bilibili (videos/slides)
- Google Colab (notebook execution)
- Kaggle, Gradescope, JudgeBoi (assignment submission/execution)
- QQ groups for community
- Maintainer’s other repos and update log—meta‐information layer.

- GitHub Repository (root)
- Year Modules: 2021 ML, 2022 ML, 2023 ML
- Content Types inside each module:
– Lecture Topics
– Assignment Folders
– Sample Code Folders
- README.md (global navigation)
- External Services: Bilibili, Google Colab, Kaggle, Gradescope, QQ Groups
- README.md → Year Modules (navigation)
- Year Module → Topic Folder → Material Files
- Material Files → External Service (e.g., notebook → run on Colab, slide → view on Bilibili)
- Assignments → Submission Platforms (Kaggle, JudgeBoi, Gradescope)
c. Architectural patterns/design principles:
- **Layered content organization** (Root README → Year → Topic → Material)
- **Separation of concerns**:
– Learning materials (notebooks/slides) vs. assignment code vs. raw data
- **Decentralized content delivery**: heavy reliance on external hosting (Colab, Bilibili)
d. Relevant technologies/frameworks:
- Git & GitHub for version control and hosting
- Markdown for documentation
- Jupyter Notebooks for interactive code
- PDF/slide decks for lecture materials
- External web platforms (Colab, Kaggle, Bilibili, QQ)

##### Checklist for the principal software engineer
- “This is a directory,”
- “This is a notebook,”
- Root README is prominent as the **entry point**.
- Every year‐folder and its immediate topics—don’t over‐aggregate; the value here is in the granularity of course structure.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Root and navigation
    Repo["GitHub Repository"]:::folder
    Repo --> README["README.md"]:::doc

    %% Year modules
    README --> Year2021["2021 ML"]:::folder
    README --> Year2022["2022 ML"]:::folder
    README --> Year2023["2023 ML"]:::folder

    %% 2021 ML structure
    subgraph "2021 ML Structure"
        direction TB
        Y21README["README.md"]:::doc
        Intro["01 Introduction"]:::folder
        HW1["作业HW1"]:::folder
        SampleCode["助教作业范例"]:::folder
        TAColab["Colab Examples"]:::folder

        Y21README --> Intro
        Intro --> Notebook1["Lecture Notebook.ipynb"]:::notebook
        Intro --> Slide1["Lecture Slides.pdf"]:::pdf
        Intro --> Data1["Dataset.csv"]:::csv
        Intro --> HW1
        SampleCode --> TAColab
    end
    Year2021 --> Y21README

    %% 2022 ML structure
    subgraph "2022 ML Structure"
        direction TB
        Y22README["README.md"]:::doc
        Elective["选修 To Learn More"]:::folder

        Y22README --> Elective
    end
    Year2022 --> Y22README

    %% 2023 ML structure
    subgraph "2023 ML Structure"
        direction TB
        Y23README["README.md"]:::doc
        ChatGPT["01 正确认识 ChatGPT"]:::folder
        Assignments23["作业"]:::folder

        Y23README --> ChatGPT
        Y23README --> Assignments23
    end
    Year2023 --> Y23README

    %% External services
    Notebook1 -.->|"run on"| Colab["Google Colab"]:::external
    Slide1 -.->|"view on"| Bilibili["Bilibili"]:::external
    Data1 -.->|"explore on"| Kaggle["Kaggle"]:::external
    HW1 -.->|"submit to"| Gradescope["Gradescope"]:::external
    HW1 -.->|"submit to"| JudgeBoi["JudgeBoi"]:::external
    Elective -.->|"learn more on"| Bilibili
    ChatGPT -.->|"watch on"| Bilibili

    %% Click Events
    click Repo "https://github.com/fafa-dl/lhy_machine_learning/tree/main//"
    click README "https://github.com/fafa-dl/lhy_machine_learning/blob/main//README.md"
    click Year2021 "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2021 ML"
    click Year2022 "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2022 ML"
    click Year2023 "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2023 ML"
    click Y21README "https://github.com/fafa-dl/lhy_machine_learning/blob/main//2021 ML/README.md"
    click Y22README "https://github.com/fafa-dl/lhy_machine_learning/blob/main//2022 ML/README.md"
    click Intro "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2021 ML/01 Introduction"
    click HW1 "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2021 ML/01 Introduction/作业HW1"
    click SampleCode "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2021 ML/助教作业范例"
    click TAColab "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2021 ML/助教作业范例/Colab"
    click Elective "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2022 ML/选修 To Learn More"
    click ChatGPT "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2023 ML/01 正确认识 ChatGPT"
    click Assignments23 "https://github.com/fafa-dl/lhy_machine_learning/tree/main//2023 ML/作业"

    %% Styles
    classDef folder fill:#ECECEC,stroke:#888888;
    classDef doc fill:#D5E8D4,stroke:#82B366;
    classDef notebook fill:#DAE8FC,stroke:#6C8EBF;
    classDef pdf fill:#E1FFD4,stroke:#82B366;
    classDef csv fill:#FFE6CC,stroke:#D79B00;
    classDef external fill:#F3E5F5,stroke:#CE93D8,color:#6A0080;
```
