Skip to content

Commit 96d961a

Browse files
committed
DOCS add link blocks to index files.md
Update README.md [DOCS] add link blocks in metro [DOCS] translate to md [DOCS] add link blocks, pass 1 translate to md Remove defunct rst after md migration [DOCS] metro add link blocks [DOCS] metro add link blocks format fix [DOCS] educ add link blocks, pass 1 translate to md [DOCS] manuf add link blocks
1 parent 4de0025 commit 96d961a

File tree

17 files changed

+347
-266
lines changed
  • education-ai-suite/smart-classroom/docs/user-guide
  • manufacturing-ai-suite
    • hmi-augmented-worker/docs/user-guide
    • industrial-edge-insights-multimodal/docs/user-guide/weld-defect-detection
    • industrial-edge-insights-time-series/docs/user-guide
    • industrial-edge-insights-vision/docs/user-guide
  • metro-ai-suite

17 files changed

+347
-266
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Smart Classroom
2+
3+
<!--hide_directive
4+
<div class="component_card_widget">
5+
<a class="icon_github" href="https://github.com/open-edge-platform/edge-ai-suites/tree/release-2025.2.0/education-ai-suite/smart-classroom">
6+
GitHub project
7+
</a>
8+
<a class="icon_document" href="https://github.com/open-edge-platform/edge-ai-suites/blob/release-2025.2.0/education-ai-suite/smart-classroom/README.md">
9+
Readme
10+
</a>
11+
</div>
12+
hide_directive-->
13+
14+
The Smart Classroom project is a modular, extensible framework designed to process and summarize educational content using advanced AI models. It supports transcription, summarization, and future capabilities like video understanding and real-time analysis.
15+
16+
The main features are as follows:
17+
18+
- **Audio transcription** with ASR models (e.g., Whisper, Paraformer)
19+
- **Summarization** using powerful LLMs (e.g., Qwen, LLaMA)
20+
- **Plug-and-play architecture** for integrating new ASR and LLM models
21+
- **API-first design** ready for frontend integration
22+
- **Extensible roadmap** for real-time streaming, diarization, translation, and video analysis
23+
24+
<!--hide_directive
25+
:::{toctree}
26+
:hidden:
27+
28+
system-requirements
29+
get-started
30+
release-
31+
32+
:::
33+
hide_directive-->

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

Lines changed: 0 additions & 20 deletions
This file was deleted.

manufacturing-ai-suite/hmi-augmented-worker/docs/user-guide/index.rst renamed to manufacturing-ai-suite/hmi-augmented-worker/docs/user-guide/index.md

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
HMI Augmented Worker
2-
============================================
1+
# HMI Augmented Worker
2+
3+
<!--hide_directive
4+
<div class="component_card_widget">
5+
<a class="icon_github" href="https://github.com/open-edge-platform/edge-ai-suites/tree/release-2025.2.0/manufacturing-ai-suite/hmi-augmented-worker">
6+
GitHub project
7+
</a>
8+
<a class="icon_document" href="https://github.com/open-edge-platform/edge-ai-suites/blob/release-2025.2.0/manufacturing-ai-suite/hmi-augmented-worker/README.md">
9+
Readme
10+
</a>
11+
</div>
12+
hide_directive-->
313

414
The HMI Augmented Worker is a RAG enabled HMI application deployed on Type-2 hypervisors.
515
Deploying RAG-enabled HMI applications in a Type-2 hypervisor setup allows flexible and
@@ -8,10 +18,10 @@ a single physical machine.
818

919
In this architecture, the HMI application operates within a Windows® virtual machine managed
1020
by a Type-2 hypervisor such as
11-
`EMT <https://github.com/open-edge-platform/edge-microvisor-toolkit>`__.
21+
[EMT](https://github.com/open-edge-platform/edge-microvisor-toolkit).
1222
The Retrieval-Augmented Generation (RAG) pipeline and supporting AI services are deployed
1323
natively on a host system, which is EMT in this implementation.
14-
`Chat Question-and-Answer Core <https://github.com/open-edge-platform/edge-ai-libraries/tree/release-2025.2.0/sample-applications/chat-question-and-answer-core>`__
24+
[Chat Question-and-Answer Core](https://github.com/open-edge-platform/edge-ai-libraries/tree/release-2025.2.0/sample-applications/chat-question-and-answer-core)
1525
provides the RAG capability.
1626
This separation ensures robust isolation between the HMI and AI components, enabling
1727
independent scaling, maintenance, and updates. The setup leverages the strengths of both
@@ -29,15 +39,13 @@ productivity for machine operators. In this sample application, the focus is on
2939
an RAG pipeline in a Type-2 Hypervisor-based setup. There is no reference HMI used and the
3040
user is expected to do the HMI integration using the RAG pipeline APIs provided.
3141

32-
How it works
33-
############
42+
## How it works
3443

3544
This section highlights the high-level architecture of the sample application.
3645

37-
High-Level Architecture
38-
+++++++++++++++++++++++
46+
### High-Level Architecture
3947

40-
The system has a RAG pipeline reusing ``Chat Question and Answer Core`` application
48+
The system has a RAG pipeline reusing `Chat Question and Answer Core` application
4149
running on the host alongside a typical HMI application which is executing on
4250
the Windows® Guest VM (virtual machine). A knowledge base is initialized by using the
4351
contents from a pre-configured folder. The folder contains the knowledge base like user
@@ -51,27 +59,23 @@ and runs independently from the HMI application. The HMI application is responsi
5159
providing the required interface along with associated user experience to enable
5260
the operator to access this knowledge base.
5361

62+
![HMI augmented worker architecture diagram](./_images/hmi-augmented-worker-architecture.png)
5463

55-
.. image:: ./_images/hmi-augmented-worker-architecture.png
56-
:alt: HMI Augmented Worker Architecture Diagram
57-
58-
Chat Question-and-Answer Core (ChatQnA Core)
59-
++++++++++++++++++++++++++++++++++++++++++++
64+
### Chat Question-and-Answer Core (ChatQnA Core)
6065

6166
The 'ChatQnA Core' sample application serves as a basic Retrieval Augmented Generation
6267
(RAG) pipeline, allowing users to pose questions and obtain answers, even from their
6368
private data corpus. This sample application illustrates the construction of RAG pipelines.
6469
It is designed for minimal memory usage, being developed as a single, monolithic application
6570
with the complete RAG pipeline integrated into one microservice.
6671

67-
The 'ChatQnA Core` application should be setup on the host system. For further details,
68-
visit `Chat Question-and-Answer Core Sample Application Overview <https://github.com/open-edge-platform/edge-ai-libraries/blob/release-2025.2.0/sample-applications/chat-question-and-answer-core/docs/user-guide/overview.md>`__.
72+
The `ChatQnA Core` application should be setup on the host system. For further details,
73+
visit [Chat Question-and-Answer Core Sample Application Overview](https://github.com/open-edge-platform/edge-ai-libraries/blob/release-2025.2.0/sample-applications/chat-question-and-answer-core/docs/user-guide/overview.md).
6974
The application is used as is without any changes.
7075
The configurable parameters like the LLM model, Embedding model, Reranker model, or
7176
Retriever model are setup based on the HMI application requirement.
7277

73-
File Watcher Service
74-
++++++++++++++++++++
78+
### File Watcher Service
7579

7680
The File Watcher Service runs alongside with HMI application on the Windows environment,
7781
consistently observing file system activities like creation, modification, and deletion.
@@ -80,11 +84,9 @@ When changes are detected, it sends the pertinent file data over the network to
8084
Retrieval-Augmented Generation (RAG) workflows. The watcher service logic is shown in
8185
the following flow diagram:
8286

83-
.. image:: ./_images/file-watcher-implementation-logic.png
84-
:alt: File Watcher Service Implementation Logic Flow
87+
![file watcher service implementation logic flow](./_images/file-watcher-implementation-logic.png)
8588

86-
Human Machine Interface(HMI) Application
87-
++++++++++++++++++++++++++++++++++++++++
89+
### Human Machine Interface(HMI) Application
8890

8991
A Human-Machine Interface(HMI) can vary depending on the use case or the creator.
9092
While HMIs generally serve as interface connecting users to machines, systems, or
@@ -96,17 +98,19 @@ an accurate summary to state that this sample application illustrates how the `C
9698
RAG pipeline can be executed in a Type-2 Hypervisor setup enabling applications like HMI
9799
to benefit from it.
98100

99-
Supporting Resources
100-
####################
101+
## Supporting Resources
101102

102103
For more comprehensive guidance on beginning, see the
103-
:doc:`Getting Started Guide <./get-started>`.
104-
105-
.. toctree::
106-
:hidden:
107-
108-
system-requirements
109-
get-started
110-
release-notes
111-
how-to-build-from-source
112-
Source Code <https://github.com/open-edge-platform/edge-ai-suites/tree/release-2025.2.0/manufacturing-ai-suite/hmi-augmented-worker>
104+
[Getting Started Guide](./get-started).
105+
106+
<!--hide_directive
107+
:::{toctree}
108+
:hidden:
109+
110+
system-requirements
111+
get-started
112+
release-notes
113+
how-to-build-from-source
114+
Source Code <https://github.com/open-edge-platform/edge-ai-suites/tree/release-2025.2.0/manufacturing-ai-suite/hmi-augmented-worker>
115+
:::
116+
hide_directive-->

manufacturing-ai-suite/industrial-edge-insights-multimodal/docs/user-guide/weld-defect-detection/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Let's discuss how this architecture translates to data flow in the weld defect d
1111

1212
### 1. **Weld Data Simulator**
1313

14-
The Weld Data Simulator uses the sets of time synchronized .avi and .csv files from the `edge-ai-suites/manufacturing-ai-suite/industrial-edge-insights-multimodal/weld-data-simulator/simulation-data/`, subset of test dataset coming from [Intel_Robotic_Welding_Multimodal_Dataset](https://huggingface.co/datasets/amr-lopezjos/Intel_Robotic_Welding_Multimodal_Dataset).
14+
The Weld Data Simulator uses sets of time synchronized .avi and .csv files from the `edge-ai-suites/manufacturing-ai-suite/industrial-edge-insights-multimodal/weld-data-simulator/simulation-data/` subset of test dataset coming from [Intel_Robotic_Welding_Multimodal_Dataset](https://huggingface.co/datasets/amr-lopezjos/Intel_Robotic_Welding_Multimodal_Dataset).
1515
It ingests the .avi files as RTSP streams via the **mediamtx** server. This enables real-time video ingestion, simulating camera feeds for weld defect detection.
1616
Similarly, it ingests the .csv files as data points into **Telegraf** using the **MQTT** protocol.
1717

manufacturing-ai-suite/industrial-edge-insights-time-series/docs/user-guide/weld-anomaly-detection/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Weld Anomaly Detection
22

3+
<!--hide_directive
4+
<div class="component_card_widget">
5+
<a class="icon_github" href="https://github.com/open-edge-platform/edge-ai-suites/tree/release-2025.2.0/manufacturing-ai-suite/industrial-edge-insights-time-series/apps/weld-anomaly-detection">
6+
GitHub project
7+
</a>
8+
</div>
9+
hide_directive-->
10+
311
This sample app demonstrates how AI-driven analytics enable edge devices to monitor weld quality.
412
It detects anomalous weld patterns and alerts operators for timely intervention,
513
ensuring proactive maintenance, safety, and operational efficiency. No more failures
@@ -81,7 +89,6 @@ detect the anomalous power generation data points relative to wind speed.
8189

8290
**Note**: Please note, CatBoost models doesn't run on Intel GPUs.
8391

84-
8592
##### **`tick_scripts/`**
8693

8794
The TICKScript `weld_anomaly_detector.tick` determines processing of the input data coming in.
@@ -92,4 +99,3 @@ By default, it is configured to publish the alerts to **MQTT**.
9299

93100
The `weld_anomaly_detector.cb` is a model built using the CatBoostClassifier Algo of CatBoost ML
94101
library.
95-

manufacturing-ai-suite/industrial-edge-insights-time-series/docs/user-guide/wind-turbine-anomaly-detection/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Wind Turbine Anomaly Detection
22

3+
<!--hide_directive
4+
<div class="component_card_widget">
5+
<a class="icon_github" href="https://github.com/open-edge-platform/edge-ai-suites/tree/release-2025.2.0/manufacturing-ai-suite/industrial-edge-insights-time-series/apps/wind-turbine-anomaly-detection">
6+
GitHub project
7+
</a>
8+
</div>
9+
hide_directive-->
10+
311
This sample app demonstrates a time series use case by detecting anomalous power generation
412
patterns in wind turbines, relative to wind speed. By identifying deviations, it helps
513
optimize maintenance schedules and prevent potential turbine failures, enhancing
@@ -11,7 +19,6 @@ If you want to start working with it, instead, check out the
1119
[Get Started Guide](../get-started.md) or [How-to Guides](../how-to-guides/index.md)
1220
for Time-series applications.
1321

14-
1522
## App Architecture
1623

1724
As seen in the following architecture diagram, the sample app at a high-level comprises of data simulators(can act as data destinations if configured) - these in the real world would be the physical devices, the generic Time Series AI stack based on **TICK Stack** comprising of Telegraf, InfluxDB, Time Series Analytics microservice using Kapacitor and Grafana.

manufacturing-ai-suite/industrial-edge-insights-vision/docs/user-guide/pallet-defect-detection/index.rst renamed to manufacturing-ai-suite/industrial-edge-insights-vision/docs/user-guide/pallet-defect-detection/index.md

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
1-
Pallet Defect Detection
2-
==============================
1+
# Pallet Defect Detection
2+
3+
<!--hide_directive
4+
<div class="component_card_widget">
5+
<a class="icon_github" href="https://github.com/open-edge-platform/edge-ai-suites/tree/release-2025.2.0/manufacturing-ai-suite/industrial-edge-insights-vision/apps/pallet-defect-detection">
6+
GitHub project
7+
</a>
8+
<a class="icon_document" href="https://github.com/open-edge-platform/edge-ai-suites/blob/release-2025.2.0/manufacturing-ai-suite/industrial-edge-insights-vision/apps/pallet-defect-detection/README.md">
9+
Readme
10+
</a>
11+
</div>
12+
hide_directive-->
313

414
Automated quality control with AI-driven vision systems.
515

6-
Overview
7-
########
16+
## Overview
817

918
This Sample Application enables real-time pallet condition monitoring by running inference
1019
workflows across multiple AI models. It connects multiple video streams from warehouse
1120
cameras to AI-powered pipelines, all operating efficiently on a single industrial PC.
1221
This solution enhances logistics efficiency and inventory management by detecting
1322
defects before they impact operations.
1423

15-
How It Works
16-
############
24+
## How It Works
1725

1826
This sample application consists of the following microservices:
1927
DL Streamer Pipeline Server, Model Registry Microservice(MRaaS), MediaMTX server,
@@ -31,39 +39,35 @@ be seen on Prometheus UI. Any desired AI model from the Model Registry Microserv
3139
(which can interact with Postgres, Minio and Geti Server for getting the model) can be
3240
pulled into DL Streamer Pipeline Server and used for inference in the sample application.
3341

34-
.. figure:: ./images/industrial-edge-insights-vision-architecture.drawio.svg
35-
:alt: Architecture and high-level representation of the flow of data through the architecture
36-
37-
Figure 1: Architecture diagram
42+
![architecture and high-level representation of the flow of data through the architecture](./images/industrial-edge-insights-vision-architecture.drawio.svg)
3843

3944
This sample application is built with the following Intel Edge AI Stack Microservices:
4045

41-
- `DL Streamer Pipeline Server <https://docs.openedgeplatform.intel.com/2025.2/edge-ai-libraries/dlstreamer-pipeline-server/index.html>`__
46+
- [DL Streamer Pipeline Server](https://docs.openedgeplatform.intel.com/2025.2/edge-ai-libraries/dlstreamer-pipeline-server/index.html)
4247
is an interoperable containerized microservice based on Python for video ingestion
4348
and deep learning inferencing functions.
44-
- `Model Registry Microservice <https://docs.openedgeplatform.intel.com/2025.2/edge-ai-libraries/model-registry/index.html>`__
49+
- [Model Registry Microservice](https://docs.openedgeplatform.intel.com/2025.2/edge-ai-libraries/model-registry/index.html)
4550
provides a centralized repository that facilitates the management of AI models
4651

4752
It also consists of the below Third-party microservices:
4853

49-
- `Nginx <https://hub.docker.com/_/nginx>`__
54+
- [Nginx](https://hub.docker.com/_/nginx)
5055
is a high-performance web server and reverse proxy that provides TLS termination and unified HTTPS access.
51-
- `MediaMTX Server <https://hub.docker.com/r/bluenviron/mediamtx>`__
56+
- [MediaMTX Server](https://hub.docker.com/r/bluenviron/mediamtx)
5257
is a real-time media server and media proxy that allows to publish webrtc stream.
53-
- `Coturn Server <https://hub.docker.com/r/coturn/coturn>`__
58+
- [Coturn Server](https://hub.docker.com/r/coturn/)
5459
is a media traffic NAT traversal server and gateway.
55-
- `Open telemetry Collector <https://hub.docker.com/r/otel/opentelemetry-collector-contrib>`__
60+
- [Open telemetry Collector](https://hub.docker.com/r/otel/opentelemetry-collector-contrib)
5661
is a set of receivers, exporters, processors, connectors for Open Telemetry.
57-
- `Prometheus <https://hub.docker.com/r/prom/prometheus>`__
62+
- [Prometheus](https://hub.docker.com/r/prom/prometheus)
5863
is a systems and service monitoring system used for viewing Open Telemetry.
59-
- `Postgres <https://hub.docker.com/_/postgres>`__
64+
- [Postgres](https://hub.docker.com/_/postgres)
6065
is object-relational database system that provides reliability and data integrity.
61-
- `Minio <https://hub.docker.com/r/minio/minio>`__
66+
- [Minio](https://hub.docker.com/r/minio/minio)
6267
is high performance object storage that is API compatible with
6368
Amazon S3 cloud storage service.
6469

65-
Features
66-
########
70+
## Features
6771

6872
This sample application offers the following features:
6973

@@ -73,9 +77,9 @@ This sample application offers the following features:
7377
- Interconnected warehouses deliver analytics for quick and informed tracking and
7478
decision making.
7579

76-
77-
.. toctree::
78-
:hidden:
80+
<!--hide_directive
81+
:::{toctree}
82+
:hidden:
7983
8084
overview-architecture
8185
system-requirements
@@ -103,3 +107,6 @@ This sample application offers the following features:
103107
environment-variables
104108
105109
release_notes/Overview
110+
111+
:::
112+
hide_directive-->

0 commit comments

Comments
 (0)