# sharifizarchi/introduction_to_machine_learning architecture

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

- Interactive diagram: https://gitdiagram.com/sharifizarchi/introduction_to_machine_learning
- Repository: https://github.com/sharifizarchi/introduction_to_machine_learning

## Overview

##### Project type and purpose
- This is not a traditional software application but a **static content repository** for a university Machine Learning course.
- Its purpose is to manage course materials—slides, Jupyter notebooks, exercises, exams, solutions, and archives of previous semesters—using Git/GitHub as version control and distribution.

##### File structure
- Top-level directories map to logical content modules:
- Exams (source .tex + compiled PDFs + assets)
- Exercises (questions & solutions, often Jupyter notebooks + data)
- Jupyter_Notebooks (chapter-by-chapter interactive notebooks + assets)
- Slides (LaTeX/Beamer sources + images + compiled PDFs)
- Previous_Semesters (archived materials with similar substructure)
- Configuration files are minimal (e.g., .gitignore); no build scripts are present—but LaTeX and notebooks imply a build pipeline (PDF generation, possible HTML exports).

##### README
- Confirms that this is the “Machine Learning” course repository, linking to slides, notebooks, and exercises sections, intended to be updated throughout the semester.
- Mentions Creative Commons license and external resources (SharifML.ir).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Actors
    Authors["Content Authors\n(Instructors/TAs)"]:::actor
    Students["End Users\n(Students & Visitors)"]:::enduser

    %% Source Control
    subgraph "Version Control" 
        GHRepo["GitHub Repository"]:::repo
        README["README.md"]:::metadata
        GITIGNORE[".gitignore"]:::metadata
        GHRepo --> README
        GHRepo --> GITIGNORE
    end

    %% Source Modules
    subgraph "Source Modules" 
        Slides["Slides Module"]:::source
        Notebooks["Jupyter Notebooks Module"]:::source
        Exercises["Exercises Module"]:::source
        Exams["Exams Module"]:::source
        Archives["Previous Semesters Module"]:::source
    end

    %% Licensing
    subgraph "Module Licensing" 
        SlideLIC["Slides LICENSE"]:::license
        NotebookLIC["Notebooks LICENSE"]:::license
        ExerciseLIC["Exercises LICENSE"]:::license
        ArchiveLIC["Archives LICENSE"]:::license
    end

    %% CI/CD Pipeline
    subgraph "CI/CD Build Pipeline" 
        Build["CI/CD Build Server"]:::build
        LaTeX["LaTeX Compile"]:::buildstep
        NotebookConvert["Notebook → HTML/PDF"]:::buildstep
        AssetCheck["Asset Validation"]:::buildstep
    end

    %% Artifacts
    subgraph "Build Artifacts" 
        PDFs["Generated PDFs"]:::artifact
        HTMLs["Generated HTML"]:::artifact
    end

    %% Hosting
    subgraph "Hosting & Distribution" 
        GHPages["GitHub Pages"]:::host
        LMS["LMS Integration"]:::host
        GitDownload["Git Clone/Download"]:::host
    end

    %% Flows
    Authors -->|push changes| GHRepo
    GHRepo -->|source| Slides
    GHRepo -->|source| Notebooks
    GHRepo -->|source| Exercises
    GHRepo -->|source| Exams
    GHRepo -->|source| Archives

    Slides --> SlideLIC
    Notebooks --> NotebookLIC
    Exercises --> ExerciseLIC
    Archives --> ArchiveLIC

    GHRepo -->|trigger build| Build
    Build --> LaTeX
    Build --> NotebookConvert
    Build --> AssetCheck
    LaTeX --> PDFs
    NotebookConvert --> HTMLs
    AssetCheck --> PDFs
    AssetCheck --> HTMLs

    PDFs --> GHPages
    HTMLs --> GHPages
    PDFs --> LMS
    HTMLs --> LMS
    PDFs --> GitDownload
    HTMLs --> GitDownload

    GHPages -->|view/download| Students
    LMS -->|view/download| Students
    GitDownload -->|clone/download| Students

    %% Click Events for mappings
    click Slides "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Slides/"
    click Notebooks "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Jupyter_Notebooks/"
    click Exercises "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Exercises/"
    click Exams "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Exams/"
    click Archives "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Previous_Semesters/"
    click README "https://github.com/sharifizarchi/introduction_to_machine_learning/blob/main/README.md"
    click GITIGNORE "https://github.com/sharifizarchi/introduction_to_machine_learning/blob/main/.gitignore"
    click SlideLIC "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Slides/Chapter_01_Supervised_Learning/LICENSE"
    click NotebookLIC "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Jupyter_Notebooks/Chapter_01_Supervised_Learning/LICENSE"
    click ExerciseLIC "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Exercises/Chapter_01_Supervised_Learning/LICENSE"
    click ArchiveLIC "https://github.com/sharifizarchi/introduction_to_machine_learning/tree/main/Previous_Semesters/02-03/LICENSE"
    click Notebooks "https://github.com/sharifizarchi/introduction_to_machine_learning/blob/main/Jupyter_Notebooks/README.md"
    click Slides "https://github.com/sharifizarchi/introduction_to_machine_learning/blob/main/Slides/README.md"
    click Archives "https://github.com/sharifizarchi/introduction_to_machine_learning/blob/main/Previous_Semesters/02-03/README.md"

    %% Styles
    classDef actor fill:#E3F2FD,stroke:#0D47A1,color:#0D47A1;
    classDef enduser fill:#ECEFF1,stroke:#455A64,color:#455A64;
    classDef repo fill:#BBDEFB,stroke:#1E88E5,color:#1E88E5;
    classDef metadata fill:#E8EAF6,stroke:#3949AB,color:#3949AB;
    classDef source fill:#E1F5FE,stroke:#0288D1,color:#0288D1;
    classDef license fill:#FFF3E0,stroke:#FB8C00,color:#E65100;
    classDef build fill:#C8E6C9,stroke:#43A047,color:#1B5E20;
    classDef buildstep fill:#DCEDC8,stroke:#7CB342,color:#33691E;
    classDef artifact fill:#F3E5F5,stroke:#8E24AA,color:#4A148C;
    classDef host fill:#FFE0B2,stroke:#FB8C00,color:#E65100;
```
