# yogeshsingh-11/generative-ai-for-beginners architecture

> Architecture diagram of the GitHub repository yogeshsingh-11/generative-ai-for-beginners, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yogeshsingh-11/generative-ai-for-beginners
- Repository: https://github.com/yogeshsingh-11/generative-ai-for-beginners

## Overview

##### Main Components
- Repository Infrastructure – Represent elements that support development and collaboration:
- Dev Environment & Configuration: Include the .devcontainer folder (with Setup.txt, devcontainer.json, environment.yml, post-create.sh) and .vscode settings.
- Meta-level Documents: Items like LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, and overall README.

- Lesson 00 – Course Setup: Contains setup instructions, translations, and auxiliary materials.
- A README file (explaining the lesson content and instructions)
- Code samples and assets (images, notebooks, scripts)
- Language-specific subdirectories (python, javascript/typescript, dotnet) that provide code examples for different ecosystems.
- Translation Support: Note that many folders have parallel “translations” directories (for cn, es-mx, ja-jp, ko, pt-br, tw, etc.) so include a node for “Localization/Translations” that links to many lesson modules.

- External Integrations:

##### Relationships and Interactions
– Lesson Content (README with text explanations and images)
– Code samples (organized under language-specific folders)
– Translations (linking to localization components)

##### Architectural Patterns & Design Principles
- Separation of Concerns: Indicate how translations, code samples, and documentation are separated into their own directories.
- Extensibility: Note that with multiple language examples and extensive documentation, the repository is designed to be easily forked, extended, and repurposed by learners.
- Integration Points: Clearly mark the external service integrations, showing how the course teaches interacting with APIs (for instance, Azure OpenAI Service, OpenAI API calls, etc.).

##### Technology & Frameworks
- Within the lessons, include annotations or labels identifying used technologies when relevant:
– Python (as seen in multiple lesson folders with prerequisites, notebooks, assignment scripts)
– TypeScript/JavaScript (e.g., for assignments in lessons 05, 07, 08, 09, 11)
– .NET components (in some lessons, particularly where there are .NET subdirectories)
– GitHub Actions and dev containers for development environment configuration.

##### Essential Elements
- Clear labels for every major component: “Repository Infrastructure,” “Course Lessons,” “Localization,” “External AI Services,” etc.
– Show the flow from the centralized development & configuration that supports all lessons.
– Illustrate data flow (or instructional flow) between each lesson and external APIs (for build lessons).
– Represent how translations are linked to each lesson.
- Annotations: Briefly note in each component what its purpose is (for example: “Lesson 04 – Prompt Engineering” includes code examples in Python and translation support; “06 - Text Generation Apps” integrates with Azure OpenAI and OpenAI API).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Repository Infrastructure
    subgraph "Repository Infrastructure"
        %% Dev Environment & Config
        subgraph "Dev Environment & Config"
            devContainer["Dev Container (.devcontainer)"]:::config
            vscode["VSCode Settings (.vscode)"]:::config
        end
        %% CI/CD & GitHub Workflows
        subgraph "CI/CD & Workflows"
            workflows["GitHub Workflows (.github/workflows)"]:::workflow
        end
        %% Meta Documents
        subgraph "Meta Documents"
            license["LICENSE"]:::docs
            codeCon["CODE_OF_CONDUCT.md"]:::docs
            contrib["CONTRIBUTING.md"]:::docs
            security["SECURITY.md"]:::docs
            readme["README.md"]:::docs
        end
    end

    %% Course Lessons
    subgraph "Course Lessons"
        L00["Lesson 00 - Course Setup"]:::lesson
        L01["Lesson 01 - Introduction to GenAI"]:::lesson
        L02["Lesson 02 - Exploring and Comparing LLMs"]:::lesson
        L03["Lesson 03 - Using Generative AI Responsibly"]:::lesson
        L04["Lesson 04 - Prompt Engineering Fundamentals"]:::lesson
        L05["Lesson 05 - Advanced Prompts"]:::lesson
        L06["Lesson 06 - Text Generation Apps"]:::lesson
        L07["Lesson 07 - Building Chat Applications"]:::lesson
        L08["Lesson 08 - Building Search Applications"]:::lesson
        L09["Lesson 09 - Building Image Applications"]:::lesson
        L10["Lesson 10 - Building Low-Code AI Applications"]:::lesson
        L11["Lesson 11 - Integrating with Function Calling"]:::lesson
        L12["Lesson 12 - Designing UX for AI Applications"]:::lesson
        L13["Lesson 13 - Securing AI Applications"]:::lesson
        L14["Lesson 14 - The Generative AI Application Lifecycle"]:::lesson
        L15["Lesson 15 - RAG and Vector Databases"]:::lesson
        L16["Lesson 16 - Open Source Models"]:::lesson
        L17["Lesson 17 - AI Agents"]:::lesson
        L18["Lesson 18 - Fine Tuning"]:::lesson
        L19["Lesson 19 - SLM"]:::lesson
        L20["Lesson 20 - Mistral"]:::lesson
        L21["Lesson 21 - Meta"]:::lesson
    end

    %% Localization / Translations
    trans["Localization/Translations"]:::translation

    %% External Integrations
    subgraph "External Integrations"
        Azure["Azure OpenAI Service"]:::external
        OpenAI["OpenAI API"]:::external
    end

    %% Relationships and Data Flow
    readme -->|"instructions"| L00
    devContainer -->|"supports"| L00
    workflows -->|"supports"| L00

    %% Chain lessons to show progression
    L00 --> L01
    L01 --> L02
    L02 --> L03
    L03 --> L04
    L04 --> L05
    L05 --> L06
    L06 --> L07
    L07 --> L08
    L08 --> L09
    L09 --> L10
    L10 --> L11
    L11 --> L12
    L12 --> L13
    L13 --> L14
    L14 --> L15
    L15 --> L16
    L16 --> L17
    L17 --> L18
    L18 --> L19
    L19 --> L20
    L20 --> L21

    %% Link course lessons to translations (representing that each lesson includes localization support)
    L00 -->|"hasTranslations"| trans

    %% External integration connections for applicable lessons
    L06 -->|"integrates"| Azure
    L11 -->|"integrates"| OpenAI

    %% Click Events for Repository Infrastructure
    click devContainer "https://github.com/yogeshsingh-11/generative-ai-for-beginners/blob/main/.devcontainer"
    click vscode "https://github.com/yogeshsingh-11/generative-ai-for-beginners/blob/main/.vscode"
    click workflows "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/.github/workflows"
    click license "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/LICENSE"
    click codeCon "https://github.com/yogeshsingh-11/generative-ai-for-beginners/blob/main/CODE_OF_CONDUCT.md"
    click contrib "https://github.com/yogeshsingh-11/generative-ai-for-beginners/blob/main/CONTRIBUTING.md"
    click security "https://github.com/yogeshsingh-11/generative-ai-for-beginners/blob/main/SECURITY.md"
    click readme "https://github.com/yogeshsingh-11/generative-ai-for-beginners/blob/main/README.md"

    %% Click Events for Course Lessons
    click L00 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/00-course-setup"
    click L01 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/01-introduction-to-genai"
    click L02 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/02-exploring-and-comparing-different-llms"
    click L03 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/03-using-generative-ai-responsibly"
    click L04 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/04-prompt-engineering-fundamentals"
    click L05 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/05-advanced-prompts"
    click L06 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/06-text-generation-apps"
    click L07 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/07-building-chat-applications"
    click L08 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/08-building-search-applications"
    click L09 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/09-building-image-applications"
    click L10 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/10-building-low-code-ai-applications"
    click L11 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/11-integrating-with-function-calling"
    click L12 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/12-designing-ux-for-ai-applications"
    click L13 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/13-securing-ai-applications"
    click L14 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/14-the-generative-ai-application-lifecycle"
    click L15 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/15-rag-and-vector-databases"
    click L16 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/16-open-source-models"
    click L17 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/17-ai-agents"
    click L18 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/18-fine-tuning"
    click L19 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/19-slm"
    click L20 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/20-mistral"
    click L21 "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/21-meta"

    %% Click Event for Localization
    click trans "https://github.com/yogeshsingh-11/generative-ai-for-beginners/tree/main/translations/"

    %% Click Event for External Integration (Azure file example)
    click Azure "https://github.com/yogeshsingh-11/generative-ai-for-beginners/blob/main/06-text-generation-apps/dotnet/notebook-azure-openai.dib"

    %% Styles
    classDef config fill:#e0bbff,stroke:#663399,stroke-width:2px;
    classDef workflow fill:#a0c4ff,stroke:#084298,stroke-width:2px;
    classDef docs fill:#caffbf,stroke:#228B22,stroke-width:2px;
    classDef lesson fill:#ffd6a5,stroke:#ff7f50,stroke-width:2px;
    classDef translation fill:#d0f4de,stroke:#2e8b57,stroke-width:2px;
    classDef external fill:#fff3b0,stroke:#d4a017,stroke-width:2px;
```
