# somanyadav/youtube-summariser architecture

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

- Interactive diagram: https://gitdiagram.com/somanyadav/youtube-summariser
- Repository: https://github.com/somanyadav/youtube-summariser

## Overview

##### Project type and purpose
- This is an open-source Streamlit-based web application (“Youtube Summariser”) that ingests a YouTube video URL, extracts its transcript, applies multiple summarization techniques (extractive & abstractive), optionally translates and converts the summary to speech, and renders everything in an interactive UI.

##### File structure
Top-level files and dirs:
- .devcontainer/        – VS Code dev container config
- *.ipynb              – Exploratory notebooks for each summarization approach
- app.py               – Main Streamlit application orchestrator
- requirements.txt     – Python dependencies
- README.md, LICENSE, examples.txt

Patterns:
- “app.py” coordinates:
– Transcript extraction
– Summarization modules (Gensim, NLTK, Spacy, TF-IDF, T5-abstractive)
– deep_translator for translation
– Text-to-Speech engine
- Notebooks capture prototype code for each algorithm.

##### Extract additional insights from README
- Core components: Video Transcript Extraction, Multiple Summarization Techniques, Translation, Text-to-Speech, Interactive UI.

##### Detail
- “strategy selector” inside the Summarization Engine to show runtime choice of algorithm.
- Call out requirements.txt and .devcontainer as supporting infrastructure, but not part of the runtime flow.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User
    User["User"]:::externalUser

    %% UI and Orchestrator
    UI["Streamlit UI & Controller"]:::ui
    click UI "https://github.com/somanyadav/youtube-summariser/blob/main/app.py"

    %% Core Pipeline
    subgraph "Core Processing" 
        direction TB
        TE["Transcript Extraction Service"]:::core
        click TE "https://github.com/somanyadav/youtube-summariser/blob/main/app.py"
        SE["Summarization Engine\n(Strategy Selector)"]:::core
        TS["Translation Service"]:::output
        click TS "https://github.com/somanyadav/youtube-summariser/blob/main/app.py"
        TTS["Text-to-Speech Service"]:::output
        click TTS "https://github.com/somanyadav/youtube-summariser/blob/main/app.py"
        Cache["In-Memory Cache"]:::data
    end

    %% External APIs
    subgraph "External Dependencies"
        direction TB
        YTAPI["YouTube Transcript API"]:::external
        HF["Hugging Face Transformers"]:::external
        DTAPI["deep_translator API"]:::external
    end

    %% Prototype Notebooks
    subgraph "Prototype Notebooks" 
        direction TB
        NB1["YouTube_Preprocessing.ipynb"]:::notebook
        click NB1 "https://github.com/somanyadav/youtube-summariser/blob/main/YouTube_Preprocessing.ipynb"
        NB2["Gensim_YouTube_Summarization.ipynb"]:::notebook
        click NB2 "https://github.com/somanyadav/youtube-summariser/blob/main/2) Gensim_YouTube_Summarization.ipynb"
        NB3["NLTK_YouTube_Summarization.ipynb"]:::notebook
        click NB3 "https://github.com/somanyadav/youtube-summariser/blob/main/3) NLTK_YouTube_Summarization.ipynb"
        NB4["Spacy_YouTube_Summarization.ipynb"]:::notebook
        click NB4 "https://github.com/somanyadav/youtube-summariser/blob/main/4) Spacy_YouTube_Summarization.ipynb"
        NB5["TF_IDF_Summarization.ipynb"]:::notebook
        click NB5 "https://github.com/somanyadav/youtube-summariser/blob/main/9) TF_IDF_Summarization.ipynb"
        NB6["Abstractive_Youtube_Summary.ipynb"]:::notebook
        click NB6 "https://github.com/somanyadav/youtube-summariser/blob/main/7) Abstractive_Youtube_Summary.ipynb"
        NB7["Translation_YouTube_Summary.ipynb"]:::notebook
        click NB7 "https://github.com/somanyadav/youtube-summariser/blob/main/5) Translation_YouTube_Summary.ipynb"
        NB8["Text_To_Speech_YouTube_Summary.ipynb"]:::notebook
        click NB8 "https://github.com/somanyadav/youtube-summariser/blob/main/6) Text_To_Speech_YouTube_Summary.ipynb"
    end

    %% Documentation & Config
    Docs["README.md\nexamples.txt\nrequirements.txt\n.devcontainer/devcontainer.json"]:::infra
    click Docs "https://github.com/somanyadav/youtube-summariser/blob/main/README.md"
    click Docs "https://github.com/somanyadav/youtube-summariser/blob/main/examples.txt"
    click Docs "https://github.com/somanyadav/youtube-summariser/blob/main/requirements.txt"
    click Docs "https://github.com/somanyadav/youtube-summariser/blob/main/.devcontainer/devcontainer.json"

    %% Flow
    User -->|"accesses"| UI
    UI -->|"requests transcript"| TE
    TE -->|"raw transcript"| SE
    SE -->|"summary text"| TS
    TS -->|"translated text"| TTS
    TTS -->|"audio stream"| UI
    SE -->|"(stores) summary"| Cache
    Cache -->|"(retrieves) summary"| UI

    %% External calls
    TE -->|"fetch transcript"| YTAPI
    SE -->|"uses model"| HF
    TS -->|"calls"| DTAPI

    %% Notebook references
    NB1 -.-> TE
    NB2 -.-> SE
    NB3 -.-> SE
    NB4 -.-> SE
    NB5 -.-> SE
    NB6 -.-> SE
    NB7 -.-> TS
    NB8 -.-> TTS

    %% Styles
    classDef ui fill:#9f6,stroke:#393,stroke-width:2px;
    classDef core fill:#6cf,stroke:#039,stroke-width:2px;
    classDef external fill:#fa6,stroke:#a53,stroke-width:2px;
    classDef output fill:#c6f,stroke:#63a,stroke-width:2px;
    classDef data fill:#eef,stroke:#99a,stroke-width:2px;
    classDef notebook fill:#ffe,stroke:#cc9,stroke-width:2px,stroke-dasharray: 5 5;
    classDef externalUser fill:#eee,stroke:#999,stroke-width:2px;
    classDef infra fill:#ddd,stroke:#888,stroke-width:2px,stroke-dasharray: 3 3;
```
