# akshatmittu/judgement-citation-retrieval-using-contextual-similarity architecture

> Architecture diagram of the GitHub repository akshatmittu/judgement-citation-retrieval-using-contextual-similarity, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity
- Repository: https://github.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity

## Overview

##### Project type and purpose
- This is a full-stack, multi-page web application built in Streamlit.
- Purpose: legal practitioners log in/register, enter a case description, and retrieve the most relevant legal precedents using text‐similarity (Universal Sentence Encoder + cosine similarity + SVM). They can also download selected cases as a PDF.

##### File structure
- Top-level scripts:
– 1_Login.py (entry point for authentication)
– generate_pdf.py (PDF‐generation service)
– utils.py (ML pipeline, embedding loader, similarity functions)
– README.md
- Pages directory (Streamlit’s multipage feature):
– 2_Register.py
– 3_Case.py (main retrieval UI)
– 4_About Us.py
- No separate microservices or external config files—everything runs inside one Streamlit server.

##### Pull additional insights from README
- Backend uses pre-computed SCOTUS dataset and embeddings.
- Authentication appears file-based or in‐memory (no external auth service).
- Frontend UI & routing: Streamlit’s multipage API.
- Core ML stack: Universal Sentence Encoder + Support Vector Machine + cosine ranking.

##### Main components & interactions
a. User Interface (Client Browser)
– Streamlit front end (pages: Login, Register, Case Input, About Us)
b. Streamlit Server
– Page Router (loads the correct Python script based on navigation)
– Auth Module
- User credential store (e.g., JSON or SQLite file)
– Case Retrieval Module
- Text‐preprocessing & citation-extraction
- Embedding submodule (Universal Sentence Encoder)
- Similarity & ranking engine (cosine similarity + SVM)
– PDF Generation Module (generate_pdf.py)
c. Data Stores
– SCOTUS dataset files (CSV / JSON)
– Pre-computed embeddings (binary or serialized files)
– User datastore (credentials)
d. External services (none in this project—everything is hosted in one container/process)

##### Relationships & data flows
1. User → Streamlit front end (login/register navigation)
2. Auth Module ←→ User datastore (validate or create credentials)
3. User (post-login) → Case Input page → Case Retrieval Module
4. Case Retrieval Module → SCOTUS dataset & embeddings → compute top-5 citations
5. Module returns ranked citations → UI renders text + relevance bars
6. If “Download PDF” clicked → PDF Generation Module reads selected cases → streams PDF back to browser

##### Architectural patterns & design principles
- Layered separation: UI layer (Streamlit pages) vs. service layer (auth, retrieval, PDF) vs. data layer.
- Single‐process modularity: each Python module is its own component.
- Reusability: utils.py houses all ML/utility functions for retrieval.
- Stateless page handling: Streamlit reruns script on each interaction; state managed via Streamlit’s session_state.

##### Relevant technologies & libraries
- Streamlit (UI framework)
- TensorFlow Hub (Universal Sentence Encoder)
- scikit-learn (Support Vector Machine, cosine similarity tools)
- pandas / NumPy (data handling)
- reportlab or similar (PDF generation)

##### Final checklist
- All components (UI pages, modules, data stores) present
- Annotations for key libraries and frameworks

## Diagram (Mermaid)

```mermaid
graph TB
    %% Client Layer
    subgraph "Client Browser"
        UI_Login["Login Page"]:::ui
        UI_Register["Register Page"]:::ui
        UI_Case["Case Input & Retrieval Page"]:::ui
        UI_About["About Us Page"]:::ui
    end

    %% Server Layer
    subgraph "Streamlit Server"
        Router["Page Router"] 
        Auth["Auth Module<br>(credential validation)"]:::auth
        Retrieval["Case Retrieval Module"]:::ml
        PDFMod["PDF Generation Module"]:::ml
    end

    %% Data Layer
    Scotus["SCOTUS Dataset<br>(CSV/JSON)"]:::data
    Embeddings["Pre-computed Embeddings"]:::data
    UserDB["User Credential Store"]:::data

    %% Flows
    UI_Login -->|"navigate"| Router
    UI_Register -->|"navigate"| Router
    UI_Case -->|"navigate"| Router
    UI_About -->|"navigate"| Router

    Router -->|"validate/register"| Auth
    Auth -->|"read/write"| UserDB
    Auth -->|"auth result"| Router

    Router -->|"request retrieval"| Retrieval
    Retrieval -->|"load data"| Scotus
    Retrieval -->|"load embeddings"| Embeddings
    Retrieval -->|"compute top-5 citations"| Retrieval
    Retrieval -->|"return results"| Router

    UI_Case -->|"click Download PDF"| PDFMod
    PDFMod -->|"load cases"| Scotus
    PDFMod -->|"generate PDF"| PDFMod
    PDFMod -->|"stream PDF"| UI_Case

    %% Click Events
    click UI_Login "https://github.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity/blob/main/1_Login.py"
    click UI_Register "https://github.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity/blob/main/2_Register.py"
    click UI_Case "https://github.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity/blob/main/3_Case.py"
    click UI_About "https://github.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity/blob/main/4_About Us.py"
    click Retrieval "https://github.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity/blob/main/utils.py"
    click PDFMod "https://github.com/akshatmittu/judgement-citation-retrieval-using-contextual-similarity/blob/main/generate_pdf.py"

    %% Styles
    classDef ui fill:#D0E6FF,stroke:#999,stroke-width:1px
    classDef auth fill:#E0D0FF,stroke:#999,stroke-width:1px
    classDef ml fill:#D0FFD0,stroke:#999,stroke-width:1px
    classDef data fill:#EEEEEE,stroke:#999,stroke-width:1px
```
