# vinbdigroupone/vietnamese-text-summarization architecture

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

- Interactive diagram: https://gitdiagram.com/vinbdigroupone/vietnamese-text-summarization
- Repository: https://github.com/vinbdigroupone/vietnamese-text-summarization

## Overview

##### Project type and purpose
- This is a full-stack, end-to-end Vietnamese text-summarization system.
- The root README calls it “vietnamese-text-summarization.” You have two summarization engines (extractive and abstractive) plus a Vue.js SPA front end.

##### File structure
- Top-level directories:
- Abstractive_method – Python code for the neural abstractive summarizer (train, dataset loading, model definition, evaluation).
- Extractive_method – Notebook-and-script based extractive summarizer, including a server entrypoint (server.py) and various methods (TF-IDF, centroid, PhoBERT).
- Notebooks – experiment / prototype Jupyter notebooks; these support development but are not in the production pipeline.
- client – a Vue.js single-page application (SPA) with src/, components/, views/, router/, public assets.
- Key files: requirements.txt (Python dependencies), client/package.json (JS dependencies).

##### README for additional insights
- No mention of external databases or microservices orchestration, so backend likely runs as two separate Python services or one unified Flask/FastAPI app with two modules.

##### Detail without overthinking
- Break each major block into as many subcomponents as makes sense (e.g., inside Abstractive Service: dataset loader, config, model trainer, evaluator).
- Entrypoints (main.py, server.py, client/main.js).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        User["User"]:::external
        Browser["Browser"]:::external
        SPA["Vue.js SPA"]:::frontend
        User -->|"interacts with"| Browser
        Browser -->|"loads"| SPA
        SPA -->|"POST /summarize"| API["API Gateway / HTTP Server"]:::api
    end

    %% API Layer
    subgraph "API Layer"
        direction TB
        API
    end

    %% Services Layer
    subgraph "Services Layer"
        direction TB

        subgraph "Abstractive Summarization Service"
            direction TB
            AMain["main.py"]:::service
            Args["args.py"]:::service
            Config["config.py"]:::service
            Dataset["dataset.py"]:::service
            ModelDef["model.py"]:::service
            Train["train.py"]:::service
            Evaluate["evaluate.py"]:::service
            Utils["utils.py"]:::service
            AMain --> Args
            AMain --> Config
            AMain --> Dataset
            AMain --> ModelDef
            AMain --> Train
            AMain --> Evaluate
            AMain --> Utils
            Dataset -->|"loads data"| ModelDef
            ModelDef --> Train
            ModelDef --> Evaluate
        end

        subgraph "Extractive Summarization Service"
            direction TB
            EServer["server.py"]:::service
            TFIDF["TF_IDF_Sentence_Scoring.ipynb"]:::notebook
            Centroid["Extractive_Centroid_based_text_sum.ipynb"]:::notebook
            PhoBERT["phobert_extractive_text_summ.py"]:::service
            subgraph "binhdao Module"
                direction TB
                BMain["main.py"]:::service
                BDataset["Dataset.py"]:::service
                BBase["base.py"]:::service
                BModel["model.py"]:::service
                BEmbed["centroid_word_embeddings.py"]:::service
                BEval["evaluate.py"]:::service
                BMain --> BDataset
                BMain --> BBase
                BMain --> BModel
                BModel --> BEmbed
                BMain --> BEval
            end
            EServer --> TFIDF
            EServer --> Centroid
            EServer --> PhoBERT
            EServer --> BMain
        end
    end

    %% Flows back to SPA
    API -->|"returns summary"| SPA

    %% Shared Dependencies and Notebooks
    Requirements["requirements.txt"]:::docs
    PackageJSON["package.json"]:::docs
    Notebooks["Notebooks/"]:::docs

    Requirements -.-> AMain
    Requirements -.-> EServer
    PackageJSON -.-> SPA
    Notebooks -.-> TFIDF
    Notebooks -.-> Centroid

    %% Model Artifacts Storage
    Pretrained["Pretrained Model Checkpoints"]:::storage
    Pretrained --> AMain
    Pretrained --> PhoBERT

    %% Click Events
    click SPA "https://github.com/vinbdigroupone/vietnamese-text-summarization/tree/main/client/"
    click User "https://github.com/vinbdigroupone/vietnamese-text-summarization/tree/main/client/"
    click Browser "https://github.com/vinbdigroupone/vietnamese-text-summarization/tree/main/client/"
    click SPA "https://github.com/vinbdigroupone/vietnamese-text-summarization/tree/main/client/"
    click SPA "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/client/src/main.js"
    click SPA "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/client/src/router/index.js"
    click SPA "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/client/src/components/ExtractiveCom.vue"
    click SPA "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/client/src/views/Abstractive.vue"
    click SPA "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/client/src/views/Home.vue"
    click API "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/server.py"
    click Args "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/args.py"
    click Config "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/config.py"
    click Dataset "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/dataset.py"
    click ModelDef "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/model.py"
    click Train "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/train.py"
    click Evaluate "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/evaluate.py"
    click Utils "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/utils.py"
    click AMain "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Abstractive_method/main.py"
    click TFIDF "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/TF_IDF_Sentence_Scoring.ipynb"
    click Centroid "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/Extractive_Centroid_based_text_sum.ipynb"
    click PhoBERT "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/phobert_extractive_text_summ.py"
    click BDataset "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/binhdao/Dataset.py"
    click BBase "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/binhdao/base.py"
    click BModel "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/binhdao/model.py"
    click BEmbed "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/binhdao/centroid_word_embeddings.py"
    click BEval "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/binhdao/evaluate.py"
    click BMain "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/Extractive_method/binhdao/main.py"
    click Requirements "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/requirements.txt"
    click PackageJSON "https://github.com/vinbdigroupone/vietnamese-text-summarization/blob/main/client/package.json"
    click Notebooks "https://github.com/vinbdigroupone/vietnamese-text-summarization/tree/main/Notebooks/"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef api fill:#E6FFDC,stroke:#28A745,color:#22863A;
    classDef service fill:#FFF5D9,stroke:#D29922,color:#B08800;
    classDef storage fill:#FFE7D9,stroke:#DD6B20,color:#CB2431;
    classDef docs fill:#F0F0F0,stroke:#6A737D,color:#6A737D;
    classDef notebook fill:#F5F0FF,stroke:#6F42C1,color:#6F42C1;
    classDef external fill:#FFFFFF,stroke:#CCCCCC,color:#000000;
```
