Skip to content

Commit 61108a1

Browse files
authored
added the how it works section (#967)
1 parent 3b244ae commit 61108a1

File tree

4 files changed

+61
-0
lines changed

4 files changed

+61
-0
lines changed

education-ai-suite/smart-classroom/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ The basic architecture follows a modular pipeline designed for efficient audio s
2727
![High-Level System Diagram](./docs/user-guide/images/architecture.svg)
2828

2929

30+
For more information see [How it works](./docs/user-guide/how-it-works.md)
31+
3032
## Learn More
3133

3234
[Release Notes](./docs/user-guide/release-notes.md)
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
2+
# How It Works
3+
This section provides a high-level view of how the application processes audio input and integrates with a modular backend architecture.
4+
5+
![High-Level System Diagram](./images/education-ai-suite-smart-class-backend-service-layer.drawio.svg)
6+
7+
## Inputs
8+
9+
**Audio Files**
10+
You can upload audio recordings through the *Web-based UI layer*, which supports:
11+
12+
- Audio upload
13+
- Viewing transcription, summaries, and performance metrics
14+
- Localisation options (English/Chinese)
15+
16+
The uploaded audio is passed to the Backend API, which acts as the gateway to the backend service layer and provides similar capabilities.
17+
18+
**Processing**
19+
20+
- **Audio Pre-processing**
21+
Cleans and formats audio data for downstream tasks.
22+
23+
24+
- **ASR Component (Automatic Speech Recognition)**
25+
Converts audio into text using integrated ASR providers:
26+
- FunASR
27+
- OpenVINO
28+
- OpenAI
29+
30+
31+
- **Summariser Component**
32+
Generates concise summaries of transcribed text using LLM providers:
33+
- iPexLLM
34+
- OpenVINO
35+
36+
- **Metrics Collector**
37+
Monitors and collects:
38+
- xPU utilisation for hardware performance
39+
- LLM metrics for summarisation efficiency
40+
41+
42+
## Outputs
43+
44+
- Transcriptions and summaries can be accessed from the Web-based UI and file system. The path for file system is **/<project-location>/<your-project-name>/**. For example, /storage/chapter-10/
45+
- Performance metrics (e.g., utilisation, model efficiency) are displayed for monitoring.
46+
- Localisation ensures outputs are available in multiple languages (English/Chinese).
47+
48+
49+
## Learn More
50+
51+
- [System Requirements](system-requirements.md): Check the hardware and software requirements for deploying the application.
52+
- [Get Started](get-started.md): Follow step-by-step instructions to set up the application.
53+
54+

education-ai-suite/smart-classroom/docs/user-guide/images/education-ai-suite-smart-class-backend-service-layer.drawio.svg

Lines changed: 4 additions & 0 deletions
Loading

education-ai-suite/smart-classroom/docs/user-guide/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The main features are as follows:
1414
:hidden:
1515

1616
system-requirements
17+
how-it-works
1718
get-started
1819
release-notes
1920

0 commit comments

Comments
 (0)