Skip to content

feat(edgeai): Add Comprehensive AM62DX EdgeAI documentation - #816

Draft
PrathamTI wants to merge 36 commits into
TexasInstruments:masterfrom
PrathamTI:am62d-edgeai
Draft

PrathamTI wants to merge 36 commits into
TexasInstruments:masterfrom
PrathamTI:am62d-edgeai

Conversation

@PrathamTI

Copy link
Copy Markdown
Contributor

This PR introduces a complete, production-ready documentation suite for AM62DX Edge AI audio processing, featuring new plugin extension guides, visual GStreamer pipeline diagrams, comprehensive build and deployment instructions, and an out-of-box web demo guide. The documentation supports both reference implementations and custom Bring-Your-Own-Model (BYOM) workflows.

junechul and others added 30 commits October 13, 2026 19:07
Signed-off-by: JuneChul Roh <jroh@ti.com>
Signed-off-by: JuneChul Roh <jroh@ti.com>
…M62D setup

Signed-off-by: JuneChul Roh <jroh@ti.com>
Audio AI docs prefix every shell command with "$ "; configure copybutton
to strip it so copied text is directly runnable.

Signed-off-by: JuneChul Roh <jroh@ti.com>
Signed-off-by: JuneChul Roh <jroh@ti.com>
…tion.

Signed-off-by: JuneChul Roh <jroh@ti.com>
…l zoo URL

Rename source/devices/AM62DX/audioai to edgeai and the AM62DX_audioai_*
config files to AM62DX_edgeai_*. Point __MODELZOO_REPO_URL__ and the
model zoo clone command to TexasInstruments/audioai-modelzoo.

Signed-off-by: JuneChul Roh <jroh@ti.com>
Split into "Model Compile and Evaluate" (model_compile_evaluate.rst) and
"Model Inspect" (model_inspect.rst). Update the toctree, the AM62DX edgeai
toc config, labels, and cross-references in the other pages.

Signed-off-by: JuneChul Roh <jroh@ti.com>
Trim the Vale vocabulary to the entries Vale needs, fix heading adornments and non-ASCII text, use isonum.txt and #. autonumbered steps, and replace the removed replacement variables with literal values.

Signed-off-by: JuneChul Roh <jroh@ti.com>
…mentation

Add comprehensive documentation for AM62D EdgeAI audio AI applications:

- overview.rst: Platform overview, hardware architecture, and key features
- getting_started_platform.rst: Hardware setup, network connection, and audio device configuration
- getting_started_gstreamer.rst: GStreamer pipeline examples and BYOM guide
- linux_audio_inference_app.rst: C++ reference application build and deployment
- audio_ai_model_workflow.rst: Renamed from introduction.rst for clarity

Add supporting images for GUI demos and SDK architecture diagrams.
Update table of contents with new sections.

Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
Add comprehensive documentation for the Custom Audio GStreamer Pipeline demo,
including step-by-step guides for:
- GCRN-based speech enhancement pipeline with visualization
- YAMNet audio classification pipeline with top-3 predictions
- VGGish audio classification pipeline with class detection

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
Add comprehensive guide for extending GStreamer plugins to support new model
architectures.

Includes detailed code snippets from actual plugin source files:
- gstdspkernel.cpp: Adding new properties to tidspkernel element
- gsttitvm.cpp: Adding new properties to titvm element

Sections added:
- Supporting New Model Architectures in the Plugins
- Adding a New GStreamer Property to tidspkernel
- Adding a New Property to titvm
- Automatic Model Detection from Path
- Example: Using a New Model with Extended Plugin

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
Improve clarity and technical accuracy in Bring-Your-Own Model (BYOM) sections
All changes improve readability without altering technical content.

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
and check page build

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
The deploy workflow needs pages:write and id-token:write permissions at the
root level to properly authenticate with GitHub Pages API. Previously these
were only set on the deploy job, which wasn't sufficient.

This should fix the 'Missing environment' error when creating the deployment.

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
…rding

Add a new high-level guide (adding_new_model.rst) walking through the
steps needed to integrate a new model into the AM62DX Edge AI inference
chain: TVM compilation, DSP firmware signal-chain wiring, the Linux
application, and the GStreamer plugin. Link it into the edgeai/index.rst
toctree after model_inspect.

Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
… link

Add linux/index_Edge_AI to the AM62DX linux TOC and device index toctree so
the generic Edge AI landing page is reachable from the AM62DX linux SDK guide.
Add an AM62DX_family ifconfig block pointing to the published AM62DX EdgeAI
overview page (12_01_00_00), matching the pattern used for AM62AX and the
Jacinto7 variants.

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
…improved organization

Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
…nd fix RST hierarchy

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
:scale: 75
:align: center

GStreamer data-flow for VGGish audio classification: input WAV → STFT on DSP → VGGish model inference on TVM → console output

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as YAMnet comment

Comment thread source/devices/AM62DX/edgeai/index.rst Outdated
Processor SDK Linux Edge AI Software Developer’s Guide
######################################################

.. rubric:: Welcome to the AM62D EdgeAI/DL Software Developer's Guide

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whats DL ?

of the `rpmsg-dma <https://github.com/TexasInstruments/rpmsg-dma>`__ repository. The
application enables:

- **Real-time Audio Processing** — Process live ALSA audio devices or WAV file inputs

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Process live ALSA audio devices -> Process live input or...

application enables:

- **Real-time Audio Processing** — Process live ALSA audio devices or WAV file inputs
- **DSP Offload** — Offload STFT, ISTFT and deinterleave/interleave to the C7x DSP over RPMsg-DMA

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Offload STFT, ISTFT and deinterleave/interleave to the C7x DSP over RPMsg-DMA
Offload DSP signalchains (ex :STFT, ISTFT and deinterleave/interleave) to the C7x DSP over RPMsg-DMA

- **TVM Inference** — Run TVM-compiled deep learning models on the C7x NPU
- **Flexible I/O** — WAV files, live ALSA capture, raw PCM streams, or binary tensors
- **JSON Pipeline Configuration** — Define processing chains via JSON files
- **Model Daemon Mode** — Persistent TVM model daemon to avoid repeated artifact loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A model daemon hot-reloads artifacts without an application rebuild

- Build system
* - ``make``, ``git``
- Build utilities
* - Neo-TVM headers (``TVM_ROOT``)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use TVM or Apache-TVM

- ``build/example/edge-ai/rpmsg_inference_example`` — main inference application
- ``build/example/edge-ai/tvm_model_daemon`` — persistent model daemon

#. Install to a staging directory and transfer to the AM62D EVM:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.service file copying to EVM is missing

GCRN based Speech Enhancement
*****************************

Speech enhancement removes background noise from a recording while keeping the speech

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refer GST plugin comments and update in this file as well


$ ./devices/setup_am62d.sh

It downloads the ARM GCC 15.2 and C7000 CGT 5.0.0.LTS cross-toolchains into

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C& compiler version need update, Please check with Junchul

.. _am62dx_edgeai_oob_demo:

=========================================
Getting Started with the OOB Web GUI Demo

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting Started with the OOB Web GUI Demo
Getting Started with the OOB Demo using Web GUI

any additional setup.

The portal showcases the three core EdgeAI pipelines — home screen, speech
enhancement, and audio classification — running on the C7x DSP via the TVM runtime.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not only TVM runtime, so remove via the TVM runtime


AM62DX out-of-box web GUI home screen

This is the Sitara AM62D Edge AI Portal, a web-based user interface for managing and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the name it is DSP + EDGE AI Portal, please rerun the latest and check for correctness

This is the Sitara AM62D Edge AI Portal, a web-based user interface for managing and
evaluating Texas Instruments' AM62D Evaluation Module. The dashboard allows developers
to launch real-time audio analytics and DSP compute demos, inspect AI models via the
TIDL, and monitor live system telemetry like CPU load, memory footprints, and SDK software

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIDL ?

**GET STARTED** button that jumps straight to the Audio Intelligence demo. Below it, an
**Explore Demos And Tools** panel repeats the same three entry points (Audio Intelligence, DSP
Acceleration, AI Model Inspector) as clickable cards with a one-line description each, so a
first-time visitor does not need to use the sidebar at all to start exploring.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repeats the same -> Opens or shows Audio Intelligence, DSP Acceleration, AI Model Inspector
remove first-time visitor parts

- **Device Info panel** — ``Device``, ``Board``, ``SoC`` (AM62Dx quad Cortex-A53 @ 1.4GHz +
C7x DSP), ``IP Address``, and system ``Uptime``.
- **Runtime Status panel** — live ``CPU Load``, ``CPU Avg``, ``CPU Peak``, and ``RAM
Used/Free``, refreshed continuously while the portal is open.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is Theme details ?


Under ``Demo Selection`` on the left, three options are available:

- **Speech Enhancement** — C7x DSP noise reduction + TIDL.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

correct this one

Processor SDK Linux Edge AI for AM62DX feature overview

The SDK enables an interplay of open-source components such as GStreamer and
deep learning runtimes such as TVM-RT. The SDK supports edit-build-debug

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently it supports only TVM RT, rephrase the sentence


The SDK enables an interplay of open-source components such as GStreamer and
deep learning runtimes such as TVM-RT. The SDK supports edit-build-debug
cycles directly on the target and also on a host PC to cross-compile and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is edit-build-debug cycles ?


- **Edge AI application stack** — Linux-side applications and GStreamer pipelines
that drive audio inference using TVM-RT and open-source components.
- **Foundational Linux components** — OS, U-Boot, kernel, filesystem, and Linux

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's OS

paresh-bhagat and others added 2 commits October 23, 2026 15:53
Add a new doc for EdgeAI and new model info.

Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
…eline documentation

- Add AM62D EVM hardware setup details with boot mode diagrams and new images
- Update GStreamer pipeline documentation with improved clarity and trademark formatting
- Refresh pipeline diagrams and optimize image sizes
- Add missing user guide references and detailed system verification steps
- Standardize RST formatting and reference anchors across EdgeAI documentation

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
that drive audio inference using TVM-RT and open-source components.
- **Foundational Linux components** — OS, U-Boot, kernel, filesystem, and Linux
drivers that form the base platform.
- **DSP firmware** — C7x DSP firmware that runs the signal chain (STFT/ISTFT) and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

signal chain (ex: STFT/ISTFT)

- **Foundational Linux components** — OS, U-Boot, kernel, filesystem, and Linux
drivers that form the base platform.
- **DSP firmware** — C7x DSP firmware that runs the signal chain (STFT/ISTFT) and
TVM model inference on the dedicated DSP hardware.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is dedicated DSP hardware.

| | | Version** | | Linux** | RT Linux** | RTOS** |
+--------------+-----------------+-----------+-----------------------+-------------------+------------------+------------------+
| AM62D-EVM | AUDIO-AM62D-EVM | E2 | Hardware User's Guide | Y | Y | Y |
| AM62D-EVM | AM62D EVM | E2 | Hardware User's Guide | Y | Y | Y |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why rename AUDIO-AM62D-EVM ?

@github-actions

Copy link
Copy Markdown

New warnings found with rstcheck:

source/devices/AM62DX/index.rst:27: (SEVERE/4) File referenced in "include" directive not found: '/devices/AM62DX/linux/_Release_Specific_QSG.rst'.
source/devices/AM62DX/edgeai/getting_started_gstreamer.rst:246: (ERROR/3) (bash) syntax error near unexpected token `('
source/devices/AM62DX/edgeai/getting_started_gstreamer.rst:246: (ERROR/3) (bash) `[TVM] Live top-3 prediction printing enabled (521 classes from /usr/share/tvm_inference/labels/yamnet_label_list.txt)'
source/devices/AM62DX/edgeai/getting_started_gstreamer.rst:327: (ERROR/3) (bash) syntax error near unexpected token `('
source/devices/AM62DX/edgeai/getting_started_gstreamer.rst:327: (ERROR/3) (bash) `[TVM] Live top-3 prediction printing enabled (10 classes from /usr/share/tvm_inference/labels/vggish_label_list.txt)'
source/devices/AM62DX/edgeai/evm_hardware_setup.rst:192: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/devices/AM62DX/edgeai/evm_hardware_setup.rst:192: (ERROR/3) (bash) `ssh root@<EVM_IP_ADDRESS>'
source/devices/AM62DX/linux/Release_Specific_Supported_Platforms_and_Versions.rst:26: (ERROR/3) Malformed table.

@github-actions

Copy link
Copy Markdown

New unreachable files found with check_files.py:

WARNING:root:File not used: source/images/am62dx_edgeai_stack.png

**********************

- `AM62D-EVM <https://www.ti.com/tool/AUDIO-AM62D-EVM>`__
- `AM62D-EVM <https://www.ti.com/tool/AM62D EVM>`__

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong web link


The SDK provides software and tools to let users run high-performance audio deep learning inference on Texas Instruments' AM62DX processor. We offer a practical embedded EdgeAI solution for smart speakers, industrial monitoring, voice interfaces, and acoustic event detection applications. The AM62DX integrates a high-performance A53 ARM processor with a dedicated C7x DSP optimized for neural network inference and digital signal processing. With a few simple steps one can run real-time EdgeAI pipelines such as speech enhancement and audio classification on the C7x DSP.

The SDK enables an interplay of open-source components such as GStreamer and deep learning runtimes such as TVM-RT. The reference applications showcase EdgeAI examples such as speech enhancement and audio classification in C++ variants. The SDK supports edit-build-debug cycles directly on the target and also on a host PC to cross compile and build the applications.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one only RT, rephrase the words

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is in C++ variants ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

edit-build-debug cycles ?


The SDK provides software and tools to let users run high-performance audio deep learning inference on Texas Instruments' AM62DX processor. We offer a practical embedded EdgeAI solution for smart speakers, industrial monitoring, voice interfaces, and acoustic event detection applications. The AM62DX integrates a high-performance A53 ARM processor with a dedicated C7x DSP optimized for neural network inference and digital signal processing. With a few simple steps one can run real-time EdgeAI pipelines such as speech enhancement and audio classification on the C7x DSP.

The SDK enables an interplay of open-source components such as GStreamer and deep learning runtimes such as TVM-RT. The reference applications showcase EdgeAI examples such as speech enhancement and audio classification in C++ variants. The SDK supports edit-build-debug cycles directly on the target and also on a host PC to cross compile and build the applications.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is in C++ variants ?


The SDK provides software and tools to let users run high-performance audio deep learning inference on Texas Instruments' AM62DX processor. We offer a practical embedded EdgeAI solution for smart speakers, industrial monitoring, voice interfaces, and acoustic event detection applications. The AM62DX integrates a high-performance A53 ARM processor with a dedicated C7x DSP optimized for neural network inference and digital signal processing. With a few simple steps one can run real-time EdgeAI pipelines such as speech enhancement and audio classification on the C7x DSP.

The SDK enables an interplay of open-source components such as GStreamer and deep learning runtimes such as TVM-RT. The reference applications showcase EdgeAI examples such as speech enhancement and audio classification in C++ variants. The SDK supports edit-build-debug cycles directly on the target and also on a host PC to cross compile and build the applications.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

edit-build-debug cycles ?

* - ``libti_rpmsg_dma``
- RPMsg and DMA client library for inter-processor communication
* - ``libtvm_runtime.so``
- Neo-TVM ARM64 runtime for model inference

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apache TVM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants