Prathamesh Sarjerao Vaidya commited on
Commit
83aa2b7
·
1 Parent(s): 8c5e398

Update DOCUMENTATION.md

Browse files
Files changed (1) hide show
  1. 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
- %% Define classes for styling
198
- classDef ui fill:#cce5ff,stroke:#004085,stroke-width:2px;
199
- classDef app fill:#d4edda,stroke:#155724,stroke-width:2px;
200
- classDef ai fill:#f8d7da,stroke:#721c24,stroke-width:2px;
201
- classDef data fill:#fff3cd,stroke:#856404,stroke-width:2px;
202
- classDef external fill:#e2e3e5,stroke:#383d41,stroke-width:2px;
203
-
204
- %% UI Layer
205
- subgraph "User Interface Layer"
206
- A[FastAPI Web Interface]
207
- B[Interactive Visualizations]
208
- C[Real-time Progress Tracking]
209
- D[Multi-format Downloads]
210
- end
211
- class A,B,C,D ui;
212
-
213
- %% Application Layer
214
- subgraph "Application Layer"
215
- E[AudioIntelligencePipeline]
216
- F[Model Preloader]
217
- G[Background Task Manager]
218
- H[API Endpoints]
219
- end
220
- class E,F,G,H app;
221
-
222
- %% AI Processing Layer
223
- subgraph "AI Processing Layer"
224
- I[Speaker Diarization]
225
- J[Speech Recognition]
226
- K[Neural Translation]
227
- L[Output Formatting]
228
- end
229
- class I,J,K,L ai;
230
-
231
- %% Data Layer
232
- subgraph "Data Layer"
233
- M[Model Cache]
234
- N[Audio Storage]
235
- O[Result Storage]
236
- P[Configuration]
237
- end
238
- class M,N,O,P data;
239
-
240
- %% External Services
241
- subgraph "External Services"
242
- Q[HuggingFace Hub]
243
- R[pyannote.audio Models]
244
- S[Whisper Models]
245
- T[Translation Models]
246
- end
247
- class Q,R,S,T external;
248
-
249
- %% Connections
250
- A --> E
251
- B --> F
252
- C --> G
253
- D --> H
254
- E --> I
255
- E --> J
256
- E --> K
257
- E --> L
258
- I --> M
259
- J --> N
260
- K --> O
261
- L --> P
262
- F --> Q
263
- Q --> R
264
- Q --> S
265
- Q --> T
266
- E --> F
267
- F --> G
268
- G --> H
269
- M --> N
270
- N --> O
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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:**