Prathamesh Sarjerao Vaidya
commited on
Commit
·
83aa2b7
1
Parent(s):
8c5e398
Update DOCUMENTATION.md
Browse files- DOCUMENTATION.md +105 -75
DOCUMENTATION.md
CHANGED
|
@@ -193,81 +193,111 @@ These cached demo results ensure instant transcript, translation, and analytics
|
|
| 193 |
|
| 194 |
```mermaid
|
| 195 |
graph TB
|
| 196 |
-
|
| 197 |
-
|
| 198 |
-
|
| 199 |
-
|
| 200 |
-
|
| 201 |
-
|
| 202 |
-
|
| 203 |
-
|
| 204 |
-
|
| 205 |
-
|
| 206 |
-
|
| 207 |
-
|
| 208 |
-
|
| 209 |
-
|
| 210 |
-
|
| 211 |
-
|
| 212 |
-
|
| 213 |
-
|
| 214 |
-
|
| 215 |
-
|
| 216 |
-
|
| 217 |
-
|
| 218 |
-
|
| 219 |
-
|
| 220 |
-
|
| 221 |
-
|
| 222 |
-
|
| 223 |
-
|
| 224 |
-
|
| 225 |
-
|
| 226 |
-
|
| 227 |
-
|
| 228 |
-
|
| 229 |
-
|
| 230 |
-
|
| 231 |
-
%%
|
| 232 |
-
|
| 233 |
-
|
| 234 |
-
|
| 235 |
-
|
| 236 |
-
|
| 237 |
-
|
| 238 |
-
|
| 239 |
-
|
| 240 |
-
|
| 241 |
-
|
| 242 |
-
|
| 243 |
-
|
| 244 |
-
|
| 245 |
-
|
| 246 |
-
|
| 247 |
-
|
| 248 |
-
|
| 249 |
-
%%
|
| 250 |
-
|
| 251 |
-
|
| 252 |
-
|
| 253 |
-
|
| 254 |
-
|
| 255 |
-
|
| 256 |
-
|
| 257 |
-
|
| 258 |
-
|
| 259 |
-
|
| 260 |
-
|
| 261 |
-
|
| 262 |
-
|
| 263 |
-
|
| 264 |
-
|
| 265 |
-
|
| 266 |
-
|
| 267 |
-
F -->
|
| 268 |
-
|
| 269 |
-
|
| 270 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 271 |
```
|
| 272 |
|
| 273 |
**Key Architecture Features:**
|
|
|
|
| 193 |
|
| 194 |
```mermaid
|
| 195 |
graph TB
|
| 196 |
+
subgraph "User Interface Layer"
|
| 197 |
+
A[FastAPI Web Interface]
|
| 198 |
+
B[Interactive Visualizations]
|
| 199 |
+
C[Real-time Progress Tracking]
|
| 200 |
+
D[Multi-format Downloads]
|
| 201 |
+
end
|
| 202 |
+
|
| 203 |
+
subgraph "Application Layer"
|
| 204 |
+
E[AudioIntelligencePipeline]
|
| 205 |
+
F[Model Preloader]
|
| 206 |
+
G[Background Task Manager]
|
| 207 |
+
H[API Endpoints]
|
| 208 |
+
end
|
| 209 |
+
|
| 210 |
+
subgraph "AI Processing Layer"
|
| 211 |
+
I[Speaker Diarization]
|
| 212 |
+
J[Speech Recognition]
|
| 213 |
+
K[Neural Translation]
|
| 214 |
+
L[Output Formatting]
|
| 215 |
+
end
|
| 216 |
+
|
| 217 |
+
subgraph "Data Layer"
|
| 218 |
+
M[Model Cache]
|
| 219 |
+
N[Audio Storage]
|
| 220 |
+
O[Result Storage]
|
| 221 |
+
P[Configuration]
|
| 222 |
+
end
|
| 223 |
+
|
| 224 |
+
subgraph "External Services"
|
| 225 |
+
Q[HuggingFace Hub]
|
| 226 |
+
R[pyannote.audio Models]
|
| 227 |
+
S[Whisper Models]
|
| 228 |
+
T[Translation Models]
|
| 229 |
+
end
|
| 230 |
+
|
| 231 |
+
%% UI Layer connections
|
| 232 |
+
A --> E
|
| 233 |
+
B --> E
|
| 234 |
+
C --> G
|
| 235 |
+
D --> H
|
| 236 |
+
|
| 237 |
+
%% Application Layer internal connections
|
| 238 |
+
E --> F
|
| 239 |
+
F --> G
|
| 240 |
+
G --> H
|
| 241 |
+
H --> E
|
| 242 |
+
|
| 243 |
+
%% Application to AI Processing connections
|
| 244 |
+
E --> I
|
| 245 |
+
E --> J
|
| 246 |
+
E --> K
|
| 247 |
+
E --> L
|
| 248 |
+
|
| 249 |
+
%% AI Processing to Data Layer connections
|
| 250 |
+
I --> M
|
| 251 |
+
J --> M
|
| 252 |
+
K --> M
|
| 253 |
+
L --> M
|
| 254 |
+
I --> N
|
| 255 |
+
J --> N
|
| 256 |
+
K --> O
|
| 257 |
+
L --> O
|
| 258 |
+
|
| 259 |
+
%% Data Layer connections
|
| 260 |
+
M --> N
|
| 261 |
+
N --> O
|
| 262 |
+
P --> M
|
| 263 |
+
P --> N
|
| 264 |
+
P --> O
|
| 265 |
+
|
| 266 |
+
%% External Services connections
|
| 267 |
+
F --> Q
|
| 268 |
+
Q --> R
|
| 269 |
+
Q --> S
|
| 270 |
+
Q --> T
|
| 271 |
+
R --> I
|
| 272 |
+
S --> J
|
| 273 |
+
T --> K
|
| 274 |
+
|
| 275 |
+
%% Styling for User Interface Layer
|
| 276 |
+
classDef uiLayer fill:#e1f5fe,stroke:#0277bd,stroke-width:2px,color:#000
|
| 277 |
+
class A,B,C,D uiLayer
|
| 278 |
+
|
| 279 |
+
%% Styling for Application Layer
|
| 280 |
+
classDef appLayer fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px,color:#000
|
| 281 |
+
class E,F,G,H appLayer
|
| 282 |
+
|
| 283 |
+
%% Styling for AI Processing Layer
|
| 284 |
+
classDef aiLayer fill:#e8f5e8,stroke:#388e3c,stroke-width:2px,color:#000
|
| 285 |
+
class I,J,K,L aiLayer
|
| 286 |
+
|
| 287 |
+
%% Styling for Data Layer
|
| 288 |
+
classDef dataLayer fill:#fff3e0,stroke:#f57c00,stroke-width:2px,color:#000
|
| 289 |
+
class M,N,O,P dataLayer
|
| 290 |
+
|
| 291 |
+
%% Styling for External Services
|
| 292 |
+
classDef extLayer fill:#ffebee,stroke:#d32f2f,stroke-width:2px,color:#000
|
| 293 |
+
class Q,R,S,T extLayer
|
| 294 |
+
|
| 295 |
+
%% Subgraph styling
|
| 296 |
+
style User Interface Layer fill:#e1f5fe,stroke:#0277bd,stroke-width:3px
|
| 297 |
+
style Application Layer fill:#f3e5f5,stroke:#7b1fa2,stroke-width:3px
|
| 298 |
+
style AI Processing Layer fill:#e8f5e8,stroke:#388e3c,stroke-width:3px
|
| 299 |
+
style Data Layer fill:#fff3e0,stroke:#f57c00,stroke-width:3px
|
| 300 |
+
style External Services fill:#ffebee,stroke:#d32f2f,stroke-width:3px
|
| 301 |
```
|
| 302 |
|
| 303 |
**Key Architecture Features:**
|