shyamsridhar123 commited on
Commit
a4f7eca
Β·
1 Parent(s): 80cc8f0

updated readme to remove mermaid diagram and added a link to the space app

Browse files
Files changed (2) hide show
  1. README.md +0 -86
  2. space_app.py +2 -2
README.md CHANGED
@@ -215,92 +215,6 @@ The application implements a sophisticated **agentic architecture** where specia
215
  - **Error Handling**: Robust fallback mechanisms for AI service failures
216
  - **Integration**: Bridges Gradio interface with MCP server endpoints
217
 
218
- #### πŸ›οΈ **System Architecture**
219
-
220
- ```mermaid
221
- graph TB
222
- subgraph "Entry Points"
223
- A[space_app.py<br/>HF Spaces<br/>β€’ Gradio Interface<br/>β€’ MCP Server Endpoints]
224
- B[run.py<br/>Local Dev<br/>β€’ Development Launcher<br/>β€’ Multi-service Manager]
225
- end
226
-
227
- subgraph "Core Engine"
228
- C[app.py]
229
- D[Lesson Agent<br/>β€’ AI Content<br/>β€’ Personalized<br/>β€’ Micro-lessons]
230
- E[Quiz Agent<br/>β€’ Adaptive Quiz<br/>β€’ Smart Scoring<br/>β€’ Explanations]
231
- F[Progress Agent<br/>β€’ Analytics<br/>β€’ Difficulty Adjustment]
232
- G[Orchestrator<br/>Coordinator]
233
- end
234
-
235
- subgraph "External Services"
236
- H[Azure OpenAI<br/>β€’ GPT-4.1 for Content<br/>β€’ Intelligent Responses<br/>β€’ Adaptive Generation]
237
- I[Environment Variables<br/>β€’ Local: .env file<br/>β€’ HF Spaces: Repository Secrets]
238
- end
239
-
240
- A --> C
241
- B --> C
242
- C --> D
243
- C --> E
244
- C --> F
245
- D --> G
246
- E --> G
247
- F --> G
248
- G --> H
249
- G --> I
250
-
251
- style A fill:#e1f5fe
252
- style B fill:#e1f5fe
253
- style C fill:#f3e5f5
254
- style D fill:#e8f5e8
255
- style E fill:#e8f5e8
256
- style F fill:#e8f5e8
257
- style G fill:#fff3e0
258
- style H fill:#fce4ec
259
- style I fill:#fce4ec
260
- ```
261
-
262
- #### πŸ”— **MCP Integration Architecture**
263
-
264
- The application serves as both a **Gradio app** and **MCP server**, enabling external integrations:
265
-
266
- ```mermaid
267
- graph TD
268
- subgraph "MCP Server Endpoints"
269
- A[GET /mcp/skills<br/>List available skills]
270
- B[POST /mcp/lesson/generate<br/>Generate personalized lessons]
271
- C[GET /mcp/progress/{user}<br/>Get learning analytics]
272
- D[POST /mcp/quiz/submit<br/>Submit quiz results]
273
- end
274
-
275
- subgraph "External MCP Clients"
276
- E[Claude Desktop]
277
- F[Cursor IDE]
278
- G[Custom Tools]
279
- H[Learning Dashboards]
280
- I[Educational Platforms]
281
- end
282
-
283
- A --> E
284
- A --> F
285
- A --> G
286
- B --> E
287
- B --> F
288
- B --> G
289
- C --> H
290
- C --> I
291
- D --> H
292
- D --> I
293
-
294
- style A fill:#e3f2fd
295
- style B fill:#e3f2fd
296
- style C fill:#e3f2fd
297
- style D fill:#e3f2fd
298
- style E fill:#f1f8e9
299
- style F fill:#f1f8e9
300
- style G fill:#f1f8e9
301
- style H fill:#fff8e1
302
- style I fill:#fff8e1
303
- ```
304
 
305
  #### πŸ“‚ **File Structure**
306
 
 
215
  - **Error Handling**: Robust fallback mechanisms for AI service failures
216
  - **Integration**: Bridges Gradio interface with MCP server endpoints
217
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
218
 
219
  #### πŸ“‚ **File Structure**
220
 
space_app.py CHANGED
@@ -814,9 +814,9 @@ def main():
814
  demo.launch(
815
  server_name="0.0.0.0", # Allow external connections
816
  server_port=7860, # HF Spaces default port
817
- share=False, # Don't create public link on HF Spaces
818
  show_error=True, # Show errors in the UI
819
- debug=False # Disable debug mode in production
820
  )
821
  except Exception as e:
822
  print(f"Error launching app: {e}")
 
814
  demo.launch(
815
  server_name="0.0.0.0", # Allow external connections
816
  server_port=7860, # HF Spaces default port
817
+ share=True, # Don't create public link on HF Spaces
818
  show_error=True, # Show errors in the UI
819
+ debug=True # Disable debug mode in production
820
  )
821
  except Exception as e:
822
  print(f"Error launching app: {e}")