Skip to content

Demo_User_Guides: Update EdgeAI Gallery User-Guide #532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cshilwant merged 2 commits into from
Nov 26, 2025
Merged

Demo_User_Guides: Update EdgeAI Gallery User-Guide #532

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
516b22e
fix(Demo_User_Guides): Fix instructions for building EdgeAI GUI App
cshilwant Nov 24, 2025
bdbe220
fix(Edge_AI_Gallery_User_Guide): Handle miscellaneous fixes w.r.t sphinx
cshilwant Nov 24, 2025
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
34 changes: 20 additions & 14 deletions source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@

5. Select the 4 options as described above and click on ``Start`` to generate and start the pipeline.

.. note:: As the note suggests, it might take a while for custom pipeline to start.
.. note::

As the note suggests, it might take a while for custom pipeline to start.

.. Image:: /images/am62a_edge_ai_gallery_custom.jpg
:width: 407
Expand All @@ -86,7 +88,9 @@

7. For ease of use, the IP addr of the device is displayed at the bottom right when Network is connected.

.. note:: The IP addr is polled only for the first 100 seconds after the application has started.
.. note::

The IP addr is polled only for the first 100 seconds after the application has started.

Check warning on line 93 in source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'is polled' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'is polled' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst", "range": {"start": {"line": 93, "column": 19}}}, "severity": "INFO"}

Check warning on line 93 in source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'addr'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'addr'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst", "range": {"start": {"line": 93, "column": 14}}}, "severity": "WARNING"}

8. To close the application and go to the Wallpaper screen, use the close button on the top right corner.

Expand All @@ -99,32 +103,34 @@

9. To add new images, videos and models, you should add them in the below directories respectively

- Images - /opt/edgeai-test-data/images/
- Images - :file:`/opt/edgeai-test-data/images/`

- Videos - /opt/edgeai-test-data/videos/
- Videos - :file:`/opt/edgeai-test-data/videos/`

- Models - /opt/model_zoo/
- Models - :file:`/opt/model_zoo/`


10. To change the videos in the prebuilt pipelines used for ``Image Classification``, ``Object Detection``, ``Semantic Segmentation`` & ``Multi Channel``, you can replace the video files :file:`oob-gui-video*.h264` under :file:`/opt/oob-demo-assets/`.

11. To relaunch the application, you should run

::
.. code:: console

/etc/init.d/edgeai-launcher.sh start
/etc/init.d/edgeai-launcher.sh start

12. And to stop the application again, you should run

::
.. code:: console

/etc/init.d/edgeai-launcher.sh stop
/etc/init.d/edgeai-launcher.sh stop

.. ifconfig:: CONFIG_part_family in ('AM62AX_family')

13. To add new models to the ``Model`` dropdown list in Custom popup menu, Add the names of the models in :file:`/opt/oob-demo-assets/allowedModels.txt`.

.. note:: For the above changes to take affect, close and relaunch the application.
.. note::

For the above changes to take affect, close and relaunch the application.

14. For more information on edge AI software stack, refer `Edge AI Documentation <https://software-dl.ti.com/processor-sdk-linux/esd/AM62AX/11_01_07_05/exports/docs/edgeai/sdk_overview.html>`_

Expand Down Expand Up @@ -163,16 +169,16 @@
.. code:: console

docker pull ghcr.io/texasinstruments/debian-arm64:latest
docker run -it -v ${EDGEAI_GUI_APP_REPO}:/root/ti-apps-launcher ghcr.io/texasinstruments/debian-arm64 bash
docker run -it -v ${EDGEAI_GUI_APP_REPO}:/root/edgeai-gui-app ghcr.io/texasinstruments/debian-arm64 bash

Finally, run:

.. code:: console

cmake -B build -S . -DRT_BUILD=0 # if target is RT image, make -DRT_BUILD=1
cmake -B build -S .
make -C build

The compiled binary should be ``build/edgeai-gui-app``.
The compiled binary should be :file:`build/edgeai-gui-app`.

Check warning on line 181 in source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'build/edgeai'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'build/edgeai'", "location": {"path": "source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst", "range": {"start": {"line": 181, "column": 38}}}, "severity": "WARNING"}

Copy the compiled binary to the :file:`/usr/bin` of the target:

Expand All @@ -182,7 +188,7 @@

.. note::

This is a quick and easy way to compile ti-apps-launcher during
This is a quick and easy way to compile EdgeAI GUI App during
development, but it is a good idea to validate with Yocto builds
often. There is a possibility that compiler mismatch could present
issues in the run up to production.