atascioglu commited on
Commit
ebaee54
·
verified ·
1 Parent(s): c2c481d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +108 -7
README.md CHANGED
@@ -1,16 +1,117 @@
1
  ---
2
- title: TeachingAssistantPrototype
3
- emoji: 💬
4
  colorFrom: yellow
5
  colorTo: purple
6
  sdk: gradio
7
  sdk_version: 5.42.0
8
  app_file: app.py
9
  pinned: false
10
- hf_oauth: true
11
- hf_oauth_scopes:
12
- - inference-api
13
- short_description: Prototype of an interactive GPT-style teaching assistant for
14
  ---
 
15
 
16
- An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: ESCP AI Teaching Assistant Prototype
3
+ emoji: 🎓
4
  colorFrom: yellow
5
  colorTo: purple
6
  sdk: gradio
7
  sdk_version: 5.42.0
8
  app_file: app.py
9
  pinned: false
10
+ short_description: |
11
+ Student-facing multi-modal AI teaching assistant prototype.
 
 
12
  ---
13
+ # ESCP AI Teaching Assistant Prototype
14
 
15
+ This Space hosts a **student-facing AI Teaching Assistant prototype** developed for ESCP Business School.
16
+
17
+ The assistant is designed to support students across **four complementary roles**, each with its own memory, behavior, and constraints.
18
+
19
+ ---
20
+
21
+ ## Assistant Modes
22
+
23
+ ### 1. Course Detailer
24
+ Provides **operational and logistical information only**, such as:
25
+ - course structure and schedule
26
+ - grading scheme and deliverables
27
+ - platforms and tools
28
+ - policies (attendance, late work, AI usage)
29
+
30
+ ### 2. Reviewer
31
+ Helps students:
32
+ - summarize slides
33
+ - generate exam-style questions
34
+ - review course material for assessment preparation
35
+
36
+ ### 3. Socratic Reviewer
37
+ Supports learning through:
38
+ - guided questions
39
+ - conceptual clarification
40
+ - reflective prompts
41
+ (No direct rewriting unless explicitly requested.)
42
+
43
+ ### 4. Stakeholder
44
+ Simulates a **realistic business stakeholder** reacting to a case study,
45
+ remaining fully in character and aligned with the case context.
46
+
47
+ ---
48
+
49
+ ## Knowledge Sources
50
+
51
+ The assistant uses two structured folders:
52
+
53
+ - **`CourseContent/`**
54
+ - Syllabi
55
+ - Slides
56
+ - Course-related documents
57
+
58
+ - **`CaseStudyContent/`**
59
+ - Case descriptions
60
+ - Stakeholder context
61
+ - Internal documents
62
+
63
+ If these folders contain only placeholder files, the assistant automatically switches to **Demo Mode**.
64
+
65
+ ---
66
+
67
+ ## Demo Mode
68
+
69
+ When no official material is loaded:
70
+ - The assistant explicitly states that it is operating in **Demo Mode**
71
+ - A consistent **demo course canon** is used across *all* assistant modes
72
+ - Invented details remain internally coherent and aligned
73
+
74
+ Once demo context is introduced, it is treated as the course “reality” for the remainder of the session.
75
+
76
+ ---
77
+
78
+ ## File Uploads
79
+
80
+ Students may upload:
81
+ - PDF, DOCX, PPTX
82
+ - CSV, XLSX, JSON
83
+ - Images (PNG/JPG, OCR-enabled if available)
84
+
85
+ Uploaded files are:
86
+ - used only for the current interaction
87
+ - truncated for speed and safety
88
+ - not persisted beyond the session
89
+
90
+ ---
91
+
92
+ ## Data & Privacy Notes
93
+
94
+ - This prototype is intended for **educational demonstration purposes**
95
+ - Users should **not upload personal or sensitive data**
96
+ - Conversations are logged only for development/debugging
97
+ - API keys are managed via environment secrets and never stored in code
98
+
99
+ ---
100
+
101
+ ## Technical Stack
102
+
103
+ - **Gradio** for UI
104
+ - **Hugging Face Inference API** for LLM access
105
+ - Modular per-mode memory and instruction control
106
+ - Bounded file ingestion for performance and safety
107
+
108
+ ---
109
+
110
+ ## Status
111
+
112
+ This Space is a **prototype** intended for:
113
+ - instructional experimentation
114
+ - pedagogical design
115
+ - controlled student-facing pilots
116
+
117
+ Not yet intended for production deployment without institutional validation.