Skip to content

feat(am62dx-edgeai): Add AM62DX EdgeAI documentation - #818

Open
PrathamTI wants to merge 38 commits into
TexasInstruments:masterfrom
PrathamTI:am62d-docs
Open

PrathamTI wants to merge 38 commits into
TexasInstruments:masterfrom
PrathamTI:am62d-docs

Conversation

@PrathamTI

@PrathamTI PrathamTI commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

This PR adds documentation for the AM62DX EdgeAI software stack — audio deep-learning inference (speech enhancement and audio classification) running on the C7x DSP via TVM .

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>
…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>
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>
…grams

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
paresh-bhagat and others added 8 commits October 26, 2026 15:29
Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
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>
Rename AudioAI references to EdgeAI across RST anchors, config variables,
and file names (audio_ai_model_workflow.rst -> edgeai_model_workflow.rst) to
align with the SDK's current branding. Update .rstcheck.cfg and the AM62DX
edgeai config/toc files to match.

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

Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
Signed-off-by: Pratham Deshmukh <p-deshmukh@ti.com>
@PrathamTI PrathamTI changed the title Am62d docs feat(am62dx-edgeai): Add AM62DX EdgeAI documentation Oct 26, 2026
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.

3 participants