Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions education-ai-suite/smart-classroom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ The basic architecture follows a modular pipeline designed for efficient audio s
![High-Level System Diagram](./docs/user-guide/images/architecture.svg)


For more information see [How it works](./docs/user-guide/how-it-works.md)

## Learn More

• [Release Notes](./docs/user-guide/release-notes.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@

# How It Works
This section provides a high-level view of how the application processes audio input and integrates with a modular backend architecture.

![High-Level System Diagram](./images/education-ai-suite-smart-class-backend-service-layer.drawio.svg)

## Inputs

**Audio Files**
You can upload audio recordings through the *Web-based UI layer*, which supports:

- Audio upload
- Viewing transcription, summaries, and performance metrics
- Localisation options (English/Chinese)

The uploaded audio is passed to the Backend API, which acts as the gateway to the backend service layer and provides similar capabilities.

**Processing**

- **Audio Pre-processing**
Cleans and formats audio data for downstream tasks.


- **ASR Component (Automatic Speech Recognition)**
Converts audio into text using integrated ASR providers:
- FunASR
- OpenVINO
- OpenAI


- **Summariser Component**
Generates concise summaries of transcribed text using LLM providers:
- iPexLLM
- OpenVINO

- **Metrics Collector**
Monitors and collects:
- xPU utilisation for hardware performance
- LLM metrics for summarisation efficiency


## Outputs

- 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/
- Performance metrics (e.g., utilisation, model efficiency) are displayed for monitoring.
- Localisation ensures outputs are available in multiple languages (English/Chinese).


## Learn More

- [System Requirements](system-requirements.md): Check the hardware and software requirements for deploying the application.
- [Get Started](get-started.md): Follow step-by-step instructions to set up the application.


Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The main features are as follows:
:hidden:

system-requirements
how-it-works
get-started
release-notes