# shamshad/llm-zoomcamp architecture

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

- Interactive diagram: https://gitdiagram.com/shamshad/llm-zoomcamp
- Repository: https://github.com/shamshad/llm-zoomcamp

## Overview

##### Project type and purpose
- This is neither a traditional web application nor a backend service; it is a **course content repository** for “LLM Zoomcamp.”
- It holds lecture notebooks, markdown lessons, homework assignments, reference code, cohort-specific materials, and links to external platforms (Slack, YouTube, Airtable).
- Its goal is to teach real-world applications of LLMs over six modules and a capstone project.

##### File structure
- Top level:
- README.md, project.md, asking-questions.md, awesome-llms.md – site-wide entry points and community guidelines
- directories 01-intro through 06-project-example – module-by-module content (notebooks, markdown, JSON data, PDFs)
- cohorts – year-and-module-specific workshops, homework, Docker setups, data files
- images – visual assets for README and slides
- No service code for a running application, but Dockerfiles & docker-compose.yaml appear under cohorts/2024/04-monitoring/app
- External-service demos: Elasticsearch in module 1, Qdrant in module 2, Grafana dashboards, etc.

##### README insights
- Describes course syllabus, external links (Airtable for signup, Slack, YouTube, Telegram)
- Enumerates modules and their focus (RAG, vector search, evaluation, monitoring, best practices, end-to-end project)

##### Be detailed but avoid over-segmentation
- Every essential element: authoring, CI/CD, hosting, student environment, runtime services, and communication channels

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Content Authoring
    subgraph "Content Authoring" 
        direction TB
        subgraph "Course Modules" 
            direction TB
            M1["01-intro/"]:::content
            M2["02-vector-search/"]:::content
            M3["03-evaluation/"]:::content
            M4["04-monitoring/"]:::content
            M5["05-best-practices/"]:::content
            M6["06-project-example/"]:::content
        end
        subgraph "Site-wide Docs"
            direction TB
            D1["README.md"]:::content
            D2["project.md"]:::content
            D3["asking-questions.md"]:::content
            D4["awesome-llms.md"]:::content
        end
    end

    %% Version Control & CI/CD
    Repo["GitHub Repo & CI/CD"]:::ci

    %% Static Site Host
    Site["Static Site Host (GitHub Pages)"]:::host

    %% Student Environment
    Student["Student Environment"]:::student

    %% Dockerized Lab Services
    subgraph "Docker Lab Services" 
        direction TB
        subgraph "Monitoring Lab (Module 4)" 
            direction TB
            MonApp["04-monitoring/app"]:::service
            Grafana["Grafana Dashboard"]:::service
        end
        subgraph "Open-Source Models Lab (Module 2)" 
            direction TB
            OSApp["02-open-source/"]:::service
        end
    end

    %% External Runtime Services
    ES["Elasticsearch Demo"]:::service
    QS["Qdrant Demo"]:::service

    %% Communication & Delivery Platforms
    subgraph "External Platforms" 
        direction TB
        Slack["Slack"]:::external
        YouTube["YouTube"]:::external
        Airtable["Airtable"]:::external
        Telegram["Telegram"]:::external
    end

    %% Flows
    M1 & M2 & M3 & M4 & M5 & M6 & D1 & D2 & D3 & D4 -->|commit/push| Repo
    Repo -->|build & deploy| Site
    Site -->|access content| Student
    Student -->|clone repo| Repo
    Student -->|run labs| MonApp & OSApp
    MonApp -->|monitoring data| Grafana
    OSApp -->|vector workloads| QS
    OSApp -->|search workloads| ES
    Site -->|links to| Slack & YouTube & Airtable & Telegram
    Student -->|join community| Slack & Telegram

    %% Click Events
    click M1 "https://github.com/shamshad/llm-zoomcamp/tree/main/01-intro/"
    click M2 "https://github.com/shamshad/llm-zoomcamp/tree/main/02-vector-search/"
    click M3 "https://github.com/shamshad/llm-zoomcamp/tree/main/03-evaluation/"
    click M4 "https://github.com/shamshad/llm-zoomcamp/tree/main/04-monitoring/"
    click M5 "https://github.com/shamshad/llm-zoomcamp/tree/main/05-best-practices/"
    click M6 "https://github.com/shamshad/llm-zoomcamp/tree/main/06-project-example/"
    click D1 "https://github.com/shamshad/llm-zoomcamp/blob/main/README.md"
    click D2 "https://github.com/shamshad/llm-zoomcamp/blob/main/project.md"
    click D3 "https://github.com/shamshad/llm-zoomcamp/blob/main/asking-questions.md"
    click D4 "https://github.com/shamshad/llm-zoomcamp/blob/main/awesome-llms.md"
    click Repo "https://github.com/shamshad/llm-zoomcamp/blob/main/.gitignore"
    click MonApp "https://github.com/shamshad/llm-zoomcamp/tree/main/cohorts/2024/04-monitoring/app/"
    click Grafana "https://github.com/shamshad/llm-zoomcamp/blob/main/cohorts/2024/04-monitoring/dashboard.json"
    click OSApp "https://github.com/shamshad/llm-zoomcamp/tree/main/cohorts/2024/02-open-source/"

    %% Styles
    classDef content fill:#cfe2f3,stroke:#6fa8dc,color:#073763;
    classDef ci fill:#d9ead3,stroke:#6aa84f,color:#274e13;
    classDef host fill:#b6d7a8,stroke:#38761d,color:#274e13;
    classDef student fill:#ead1dc,stroke:#a64d79,color:#741b47;
    classDef service fill:#fff2cc,stroke:#d79b00,color:#734a12;
    classDef external fill:#f4cccc,stroke:#cc0000,color:#990000;
```
