Sathvik-kota commited on
Commit
d0dddfc
·
verified ·
1 Parent(s): 24a76a0

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +4 -12
README.md CHANGED
@@ -9,7 +9,7 @@ app_file: start.sh
9
  pinned: false
10
  ---
11
 
12
- # 🔍 Multi-Document Semantic Search Engine
13
  A **production-inspired multi-microservice semantic search system** built over 20+ text documents.
14
 
15
  Designed with:
@@ -68,8 +68,7 @@ Metrics included:
68
  - **Correct vs Incorrect Fetches**
69
 
70
  ---
71
- # ⚡ How Caching Works (Mandatory Requirement ✓)
72
-
73
  Caching happens inside **`embed_service/cache_manager.py`**.
74
 
75
  ### ✔ Prevents re-embedding unchanged files
@@ -92,8 +91,7 @@ Caching benefits:
92
 
93
  ---
94
 
95
- # 🧠 How to Run Embedding Generation (Mandatory Requirement ✓)
96
-
97
  ### Embedding happens automatically during **initialization**:
98
 
99
  `POST /initialize` (handled by API Gateway):
@@ -112,14 +110,8 @@ POST /embed_document
112
 
113
  ---
114
 
115
- # 🚦 How to Start the API
116
- Everything starts with **one command**:
117
-
118
- ```bash
119
- bash start.sh
120
-
121
 
122
- ## 🧬 Design Choices
123
 
124
  ### 1️⃣ **Microservices instead of Monolithic**
125
  - Real-world ML systems separate **indexing, embedding, routing, and inference**.
 
9
  pinned: false
10
  ---
11
 
12
+ # Multi-Document Semantic Search Engine
13
  A **production-inspired multi-microservice semantic search system** built over 20+ text documents.
14
 
15
  Designed with:
 
68
  - **Correct vs Incorrect Fetches**
69
 
70
  ---
71
+ # ⚡ How Caching Works
 
72
  Caching happens inside **`embed_service/cache_manager.py`**.
73
 
74
  ### ✔ Prevents re-embedding unchanged files
 
91
 
92
  ---
93
 
94
+ # 🧠 How to Run Embedding Generation
 
95
  ### Embedding happens automatically during **initialization**:
96
 
97
  `POST /initialize` (handled by API Gateway):
 
110
 
111
  ---
112
 
 
 
 
 
 
 
113
 
114
+ ## Design Choices
115
 
116
  ### 1️⃣ **Microservices instead of Monolithic**
117
  - Real-world ML systems separate **indexing, embedding, routing, and inference**.