Skip to content

Commit b58a22b

Browse files
[DOCS][Edu] Formatting fixes
1 parent 806f732 commit b58a22b

File tree

3 files changed

+32
-32
lines changed

3 files changed

+32
-32
lines changed

education-ai-suite/smart-classroom/docs/user-guide/application-flow.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,64 +2,65 @@
22

33
This documentation provides the end-to-end flow of the application, helps you initiate the setup, and guides you in observing and validating the results.
44

5-
*Application can be initiated either by using **Upload Files** or by clicking **Start Recording**.This documentation will guide you with upload files.*
5+
The application can be initiated either by using **Upload Files** or by clicking **Start Recording**. This documentation will guide you with upload files.
66

7-
## 1) Upload Files
7+
## Step 1: Upload Files
88

9-
By clicking any one of the upload file buttons, will open a modal for audio and video files inputs
9+
Clicking any one of the upload file buttons will open a modal for audio and video files inputs.
1010

11-
**Base Directory Path should be folder path of video files (user should manually add/copy the path)**
11+
> **Note:** Base Directory Path should be folder path of video files (user should manually add/copy the path).
1212
13-
Audio → *.mp3 or .wav or .m4a* \
14-
Video → *.mp4*
13+
Accepted file formats:
1514

16-
<p>
17-
<img src="../user-guide/_assets/uploadbutton.png" width="45%" />
18-
<img src="../user-guide/_assets/uploadmodal.png" width="45%" />
19-
</p>
15+
- Audio: *.mp3 or .wav or .m4a*
16+
- Video: *.mp4*
2017

21-
**After successful upload click Apply&Start Processing** \
22-
*Note: Search is enabled only after content segmentation*
18+
![upload button](../user-guide/_assets/uploadbutton.png)
19+
![upload modal](../user-guide/_assets/uploadmodal.png)
2320

24-
## 2) Audio Analysis and Video Streaming
21+
**After successful upload click Apply & Start Processing**
22+
23+
> **Note:** Search is enabled only after content segmentation.
24+
25+
## Step 2: Audio Analysis and Video Streaming
2526

2627
Application will start transcription after analyzing the audio and videos will get stream parallelly as below.
2728

28-
### Right Panel:
29-
**Configuration Metrics** - Deatails about the platform and software configuration along with performance metrics of summarization\
30-
**Resource Utilization** - Live monitoring of CPU, GPU, NPU, Memory and Power Utilization \
31-
**Class Engagement** - Statistics of student engagement and speaker's timeline during the class (real-time) \
32-
**Pre-Validated Models** - Shows the models being used for transcription and summarization
29+
### Right Panel
3330

31+
- **Configuration Metrics** - Details about the platform and software configuration along with performance metrics of summarization
32+
- **Resource Utilization** - Live monitoring of CPU, GPU, NPU, Memory and Power Utilization
33+
- **Class Engagement** - Statistics of student engagement and speaker's timeline during the class (real-time)
34+
- **Pre-Validated Models** - Shows the models being used for transcription and summarization
3435

3536
![Uploaded Files Processing](./_assets/processing.png)
3637

37-
## 3) Tabs Switch
38-
39-
User can switch between tabs as shown below
38+
## Step 3: Tabs Switch
4039

41-
The Room View toggle allows the user to switch between full audio–video mode and audio-only mode. When disabled, the video component is hidden and only the audio panel remains visible.
40+
The user can switch between tabs as shown below.
4241

4342
![Tabs Switch](./_assets/tabs-switch.png)
4443

45-
## 4) Transcription and Speaker Timeline
44+
The Room View toggle allows the user to switch between full audio–video mode and audio-only mode. When disabled, the video component is hidden and only the audio panel remains visible.
45+
46+
## Step 4: Transcription and Speaker Timeline
4647

47-
*Once Teacher is identified, labels are updated accordingly*
48+
*Once the Teacher is identified, labels are updated accordingly*
4849

4950
![Transcription and Speaker Timeline](./_assets/label-updated.png)
5051

51-
## 5) Content-Segmentation
52+
## Step 5: Content-Segmentation
5253

5354
*After mindmap is generated and video processing completed, Content segmentation starts and video playback is enabled for video search*
5455

55-
Audio+Video -> content segmentation is enabled after mindmap is generated and video processing completed
56+
- Audio+Video: content segmentation is enabled after the MindMap is generated and video processing completed.
5657

5758
![Content segmentation](./_assets/content-segmentation.png)
5859

59-
## 6) Final State
60+
## Step 6: Final State
6061

61-
AudioAfter transcription and post summary, MindMap gets generated \
62-
VideoAfter video Processing playbackMode is enabled and based on the topic-search the results are shown \
63-
VideoSearch -> Based on search results the video timeline is highlighted on the respective time-stamps of topic
62+
- Audio: After transcription and post summary, MindMap gets generated
63+
- Video: After video Processing playbackMode is enabled and based on the topic-search the results are shown
64+
- VideoSearch: Based on search results the video timeline is highlighted on the respective time-stamps of topic
6465

6566
![Uploaded Files Processing](./_assets/search.png)

education-ai-suite/smart-classroom/docs/user-guide/how-it-works.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# How It Works
32

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

education-ai-suite/smart-classroom/docs/user-guide/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ In this release, the **Smart Classroom** application is added. It is an extensib
2222

2323
### Documentation and Source Code
2424

25-
- <https://github.com/open-edge-platform/edge-ai-suites/tree/main/education-ai-suite>
25+
- [GitHub](https://github.com/open-edge-platform/edge-ai-suites/tree/main/education-ai-suite)

0 commit comments

Comments
 (0)