# chaitanya697/noteseek architecture

> Architecture diagram of the GitHub repository chaitanya697/noteseek, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/chaitanya697/noteseek
- Repository: https://github.com/chaitanya697/noteseek

## Overview

NoteSeek is a Flask-backed search and study-notes analysis application. A user submits queries or requests other analysis through the browser; Flask routes them to the relevant engine and returns results to the interface. The engine covers several distinct retrieval models, classification, clustering, recommendations, evaluation, and document ingestion into a live index. The index and preprocessing layer underpin multiple capabilities. Relationships among unsampled components are included only where documented by the README or named in the source index; their internal call details were not inspected.

Main entry points: [`app.py`](https://github.com/chaitanya697/noteseek/blob/main/app.py) (Flask routes), [`engine/indexer.py`](https://github.com/chaitanya697/noteseek/blob/main/engine/indexer.py) (Inverted index), [`engine/preprocessor.py`](https://github.com/chaitanya697/noteseek/blob/main/engine/preprocessor.py) (NLP preprocessing), [`engine/uploader.py`](https://github.com/chaitanya697/noteseek/blob/main/engine/uploader.py) (Document extraction)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web application"]
  node_browser["Browser interface<br/>[main.js]"]
  node_flask["Flask routes<br/>[app.py]"]
end

subgraph group_retrieval["Search and indexing"]
  node_preprocessing["NLP preprocessing<br/>[preprocessor.py]"]
  node_index[("Inverted index<br/>[indexer.py]")]
  node_ranked["VSM and BM25<br/>[retriever.py]"]
  node_boolean["Boolean search<br/>[boolean_model.py]"]
  node_language["Language models<br/>[language_model.py]"]
end

subgraph group_analysis["Document analysis"]
  node_classifier["Classification<br/>[classifier.py]"]
  node_clusterer["Clustering<br/>[clusterer.py]"]
  node_evaluator["Evaluation metrics<br/>[evaluator.py]"]
end

subgraph group_ingestion["Ingestion and recommendations"]
  node_uploader["Document extraction<br/>[uploader.py]"]
  node_recommendations["Recommendations<br/>[recommender.py]"]
end

subgraph group_state["Notes and state"]
  node_collection[("Notes collection<br/>[notes.json]")]
  node_uploads[("Uploaded files<br/>[.gitkeep]")]
end

node_student(("Student"))
node_pdfpptx["PDF/PPTX files"]

node_student -->|"submits requests"| node_browser
node_browser -->|"sends requests"| node_flask
node_flask -->|"runs search"| node_ranked
node_flask -->|"runs search"| node_boolean
node_flask -->|"routes search"| node_language
node_flask -->|"classifies text"| node_classifier
node_flask -->|"runs clustering"| node_clusterer
node_flask -->|"routes evaluation"| node_evaluator
node_flask -->|"gets suggestions"| node_recommendations
node_flask -->|"processes uploads"| node_uploader
node_flask -->|"serves documents"| node_index
node_collection -->|"provides notes"| node_index
node_index -->|"preprocesses text"| node_preprocessing
node_ranked -->|"preprocesses queries"| node_preprocessing
node_boolean -->|"processes terms"| node_preprocessing
node_language -->|"processes queries"| node_preprocessing
node_classifier -->|"preprocesses text"| node_preprocessing
node_clusterer -->|"preprocesses text"| node_preprocessing
node_recommendations -->|"preprocesses queries"| node_preprocessing
node_uploader -->|"preprocesses text"| node_preprocessing
node_ranked -->|"reads index"| node_index
node_boolean -->|"reads postings"| node_index
node_language -->|"reads term counts"| node_index
node_classifier -->|"uses document vectors"| node_index
node_clusterer -->|"uses document vectors"| node_index
node_recommendations -->|"uses document vectors"| node_index
node_pdfpptx -->|"provides files"| node_uploader
node_uploader -->|"saves uploads"| node_uploads
node_uploader -->|"adds documents"| node_index
node_ranked -->|"logs interactions"| node_recommendations

click node_browser "https://github.com/chaitanya697/noteseek/blob/main/static/js/main.js"
click node_flask "https://github.com/chaitanya697/noteseek/blob/main/app.py"
click node_collection "https://github.com/chaitanya697/noteseek/blob/main/data/notes.json"
click node_preprocessing "https://github.com/chaitanya697/noteseek/blob/main/engine/preprocessor.py"
click node_index "https://github.com/chaitanya697/noteseek/blob/main/engine/indexer.py"
click node_ranked "https://github.com/chaitanya697/noteseek/blob/main/engine/retriever.py"
click node_boolean "https://github.com/chaitanya697/noteseek/blob/main/engine/boolean_model.py"
click node_language "https://github.com/chaitanya697/noteseek/blob/main/engine/language_model.py"
click node_classifier "https://github.com/chaitanya697/noteseek/blob/main/engine/classifier.py"
click node_clusterer "https://github.com/chaitanya697/noteseek/blob/main/engine/clusterer.py"
click node_evaluator "https://github.com/chaitanya697/noteseek/blob/main/engine/evaluator.py"
click node_uploader "https://github.com/chaitanya697/noteseek/blob/main/engine/uploader.py"
click node_recommendations "https://github.com/chaitanya697/noteseek/blob/main/engine/recommender.py"
click node_uploads "https://github.com/chaitanya697/noteseek/blob/main/uploads/.gitkeep"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_browser,node_flask toneBlue
class node_preprocessing,node_index,node_ranked,node_boolean,node_language toneAmber
class node_classifier,node_clusterer,node_evaluator toneMint
class node_uploader,node_recommendations toneRose
class node_collection,node_uploads,node_student,node_pdfpptx toneIndigo
```

## Components

### Web application

- [Browser interface](https://github.com/chaitanya697/noteseek/blob/main/static/js/main.js): `static/js/main.js`
- [Flask routes](https://github.com/chaitanya697/noteseek/blob/main/app.py): `app.py`

### Search and indexing

- [NLP preprocessing](https://github.com/chaitanya697/noteseek/blob/main/engine/preprocessor.py): `engine/preprocessor.py`
- [Inverted index](https://github.com/chaitanya697/noteseek/blob/main/engine/indexer.py): `engine/indexer.py`
- [VSM and BM25](https://github.com/chaitanya697/noteseek/blob/main/engine/retriever.py): `engine/retriever.py`
- [Boolean search](https://github.com/chaitanya697/noteseek/blob/main/engine/boolean_model.py): `engine/boolean_model.py`
- [Language models](https://github.com/chaitanya697/noteseek/blob/main/engine/language_model.py): `engine/language_model.py`

### Document analysis

- [Classification](https://github.com/chaitanya697/noteseek/blob/main/engine/classifier.py): `engine/classifier.py`
- [Clustering](https://github.com/chaitanya697/noteseek/blob/main/engine/clusterer.py): `engine/clusterer.py`
- [Evaluation metrics](https://github.com/chaitanya697/noteseek/blob/main/engine/evaluator.py): `engine/evaluator.py`

### Ingestion and recommendations

- [Document extraction](https://github.com/chaitanya697/noteseek/blob/main/engine/uploader.py): `engine/uploader.py`
- [Recommendations](https://github.com/chaitanya697/noteseek/blob/main/engine/recommender.py): `engine/recommender.py`

### Notes and state

- [Notes collection](https://github.com/chaitanya697/noteseek/blob/main/data/notes.json): `data/notes.json`
- [Uploaded files](https://github.com/chaitanya697/noteseek/blob/main/uploads/.gitkeep): `uploads/.gitkeep`

### Other components

- **Student**
- **PDF/PPTX files**

## Connections

- Student → Browser interface: submits requests (evidence: `README.md`)
- Browser interface → Flask routes: sends requests (evidence: `README.md`)
- Flask routes → VSM and BM25: runs search (evidence: `app.py`)
- Flask routes → Boolean search: runs search (evidence: `app.py`)
- Flask routes → Language models: routes search (evidence: `README.md`)
- Flask routes → Classification: classifies text (evidence: `app.py`)
- Flask routes → Clustering: runs clustering (evidence: `app.py`)
- Flask routes → Evaluation metrics: routes evaluation (evidence: `README.md`)
- Flask routes → Recommendations: gets suggestions (evidence: `app.py`)
- Flask routes → Document extraction: processes uploads (evidence: `app.py`)
- Flask routes → Inverted index: serves documents (evidence: `README.md`)
- Notes collection → Inverted index: provides notes (evidence: `README.md`)
- Inverted index → NLP preprocessing: preprocesses text (evidence: `engine/indexer.py`)
- VSM and BM25 → NLP preprocessing: preprocesses queries (evidence: `engine/retriever.py`)
- Boolean search → NLP preprocessing: processes terms (evidence: `engine/boolean_model.py`)
- Language models → NLP preprocessing: processes queries (evidence: `engine/language_model.py`)
- Classification → NLP preprocessing: preprocesses text (evidence: `engine/classifier.py`)
- Clustering → NLP preprocessing: preprocesses text (evidence: `engine/clusterer.py`)
- Recommendations → NLP preprocessing: preprocesses queries (evidence: `engine/recommender.py`)
- Document extraction → NLP preprocessing: preprocesses text (evidence: `engine/uploader.py`)
- VSM and BM25 → Inverted index: reads index (evidence: `engine/retriever.py`)
- Boolean search → Inverted index: reads postings (evidence: `engine/boolean_model.py`)
- Language models → Inverted index: reads term counts (evidence: `engine/language_model.py`)
- Classification → Inverted index: uses document vectors (evidence: `engine/classifier.py`)
- Clustering → Inverted index: uses document vectors (evidence: `engine/clusterer.py`)
- Recommendations → Inverted index: uses document vectors (evidence: `engine/recommender.py`)
- PDF/PPTX files → Document extraction: provides files (evidence: `README.md`)
- Document extraction → Uploaded files: saves uploads
- Document extraction → Inverted index: adds documents (evidence: `engine/uploader.py`)
- VSM and BM25 → Recommendations: logs interactions (evidence: `app.py`)
