Skip to content

Commit 4209501

Browse files
authored
updated docs (#1973)
1 parent 8f4c696 commit 4209501

File tree

5 files changed

+28
-72
lines changed

5 files changed

+28
-72
lines changed

education-ai-suite/smart-classroom/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ models:
2525
min_words: 2
2626

2727
summarizer:
28-
provider: openvino # ipex or openvino
28+
provider: openvino
2929
name: Qwen/Qwen2.5-7B-Instruct # Qwen/Qwen2-7B-Instruct or Qwen/Qwen2.5-7B-Instruct
3030
device: GPU # GPU or CPU
3131
weight_format: int8 # supports fp16, int4, int8 (Recommended)

education-ai-suite/smart-classroom/docs/user-guide/get-started.md

Lines changed: 23 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,15 @@ To install dependencies, do the following:
1010

1111
Download from [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html), and add the `ffmpeg/bin` folder to your system `PATH`.
1212

13+
### B. Install DL Streamer
14+
15+
Download the archive from [DL Streamer assets on GitHub](https://github.com/open-edge-platform/edge-ai-libraries/releases) Extract to a new folder, for example `C:\\dlstreamer_dlls`.
16+
17+
For details, refer to [Install Guide](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/dl-streamer/get_started/install/install_guide_windows.html).
18+
1319
**Run your shell with admin privileges before starting the application**
1420

15-
### B. Clone Repository
21+
### C. Clone Repository
1622

1723
```bash
1824
git clone --no-checkout https://github.com/open-edge-platform/edge-ai-suites.git
@@ -23,7 +29,7 @@ Download from [https://ffmpeg.org/download.html](https://ffmpeg.org/download.htm
2329
cd education-ai-suite
2430
```
2531

26-
### C. Install Python dependencies
32+
### D. Install Python dependencies
2733

2834
It’s recommended to create a **dedicated Python virtual environment** for the base dependencies.
2935

@@ -37,32 +43,6 @@ python.exe -m pip install --upgrade pip
3743
pip install --upgrade -r requirements.txt
3844
```
3945

40-
### D. \[Optional] Create Python Venv for Ipex Based Summarizer
41-
42-
If you plan to use IPEX, create a separate virtual environment.
43-
44-
```bash
45-
python -m venv smartclassroom_ipex
46-
smartclassroom_ipex\Scripts\activate
47-
# Use Python 3.12.x before running pip.
48-
python.exe -m pip install --upgrade pip
49-
cd smart-classroom
50-
pip install --upgrade -r requirements.txt
51-
pip install --pre --upgrade ipex-llm[xpu_2.6] --extra-index-url https://download.pytorch.org/whl/xpu
52-
```
53-
54-
> **Note:**
55-
>
56-
> - `smartclassroom_ipex` should only be used with FunAsr and Ipex related models
57-
> (Specified in 2nd section). Don't configure Openvino related models in `smartclassroom_ipex`
58-
> - Use `smartclassroom` if you don’t need IPEX. Use `smartclassroom_ipex` if you want IPEX summarization.
59-
60-
### E. Install DL Streamer
61-
62-
Download the archive from [DL Streamer assets on GitHub](https://github.com/open-edge-platform/edge-ai-libraries/releases) Extract to a new folder, for example `C:\\dlstreamer_dlls`.
63-
64-
For details, refer to [Install Guide](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/dl-streamer/get_started/install/install_guide_windows.html).
65-
6646
## Step 2: Configuration
6747

6848
### A. Default Configuration
@@ -71,13 +51,13 @@ By default, the project uses Whisper for transcription and OpenVINO-based Qwen m
7151

7252
```bash
7353
asr:
74-
provider: openvino # Supported: openvino, openai, funasr
75-
name: whisper-tiny # Options: whisper-tiny, whisper-small, paraformer-zh etc.
54+
provider: openai # Supported: openvino, openai, funasr
55+
name: whisper-small # Options: whisper-tiny, whisper-small, paraformer-zh etc.
7656
device: CPU # Whisper currently supports only CPU
7757
temperature: 0.0
7858

7959
summarizer:
80-
provider: openvino # Options: openvino or ipex
60+
provider: openvino
8161
name: Qwen/Qwen2-7B-Instruct # Examples: Qwen/Qwen1.5-7B-Chat, Qwen/Qwen2-7B-Instruct, Qwen/Qwen2.5-7B-Instruct
8262
device: GPU # Options: GPU or CPU
8363
weight_format: int8 # Supported: fp16, fp32, int4, int8
@@ -94,57 +74,21 @@ asr:
9474
name: paraformer-zh
9575
```
9676

97-
### B. IPEX-based Summarization
98-
99-
To use IPEX for summarization, ensure:
100-
101-
- IPEX-LLM is installed.
102-
- The environment for IPEX is activated.
103-
- The configuration (`smart-classroom/config.yaml`) is updated as shown below:
104-
105-
```bash
106-
asr:
107-
provider: funasr
108-
name: paraformer-zh
109-
summarizer:
110-
provider: ipex
111-
```
112-
11377
**Important: After updating the configuration, reload the application for changes to take effect.**
11478

11579
## Step 3: Run the Application
11680

117-
Run the setup script.
118-
Open a PowerShell prompt as and administrator, run the following script and follow instructions:
119-
120-
```sh
121-
cd C:\\dlstreamer_dlls
122-
.\setup_dls_env.ps1
123-
```
124-
12581
Activate the environment before running the application:
12682

12783
```bash
128-
smartclassroom\Scripts\activate # or smartclassroom_ipex
84+
smartclassroom\Scripts\activate
12985
```
13086

13187
Run the backend:
13288

13389
```bash
13490
python main.py
13591
```
136-
137-
Bring Up the Frontend:
138-
139-
```bash
140-
cd ui
141-
npm install
142-
npm run dev -- --host 0.0.0.0 --port 5173
143-
```
144-
145-
> **Note:** Open a second (new) Command Prompt/ terminal window for the frontend.
146-
> The backend terminal stays busy serving requests.
147-
14892
You should see backend logs similar to this:
14993

15094
```text
@@ -158,6 +102,17 @@ INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
158102

159103
This means your pipeline server has started successfully and is ready to accept requests.
160104

105+
Bring Up the Frontend:
106+
107+
> **Note:** Open a second (new) Command Prompt/ terminal window for the frontend.
108+
> The backend terminal stays busy serving requests.
109+
110+
```bash
111+
cd C:\path\to\edge-ai-suites\education-ai-suite\smart-classroom\ui
112+
npm install
113+
npm run dev -- --host 0.0.0.0 --port 5173
114+
```
115+
161116
## Step 4: Access the UI
162117

163118
After starting the frontend you can open the Smart Classroom UI in a browser:

education-ai-suite/smart-classroom/ui/src/components/Footer/Footer.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ import "../../assets/css/Footer.css";
44

55
const Footer: React.FC = () => {
66
const { t } = useTranslation();
7+
const currentYear = new Date().getFullYear();
78
return (
89
<footer className="footer-bar">
9-
<span>{t('footer.copyright')}</span>
10+
<span>{t('footer.copyright', { year: currentYear })}</span>
1011
</footer>
1112
);
1213
};

education-ai-suite/smart-classroom/ui/src/i18n/en.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"timer": "Timer"
88
},
99
"footer": {
10-
"copyright": "© 2025 Smart Classroom Sample App"
10+
"copyright": "© 2025-{{year}} Smart Classroom Sample App"
1111
},
1212
"notifications": {
1313
"start": "Upload the files or Start recording to begin a new session",

education-ai-suite/smart-classroom/ui/src/i18n/zh.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"timer": "计时器"
88
},
99
"footer": {
10-
"copyright": "© 2025 智能教室示例应用"
10+
"copyright": "© 2025-{{year}} 智能教室示例应用"
1111
},
1212
"notifications": {
1313
"start": "上传文件或开始录音以开始新会话",

0 commit comments

Comments
 (0)