Skip to content

Documentation,drivers/aie: align machine learning docs with current code - #20194

Merged
acassis merged 1 commit into
apache:masterfrom
Abhishekmishra2808:docs/mlearning-sync
Sep 19, 2026
Merged

acassis merged 1 commit into
apache:masterfrom
Abhishekmishra2808:docs/mlearning-sync

Conversation

@Abhishekmishra2808

Copy link
Copy Markdown
Contributor

Summary

tflm_tool.cc registers nine operators including DEPTHWISE_CONV_2D, but the docs still said eight. The same page described tflm -C as a real compile path even though NuttX never defines TFLITE_MODEL_COMPILER, and it mixed the on-target no-heap TFLM model with the sim helper that uses ifstream / new.

This change also records the pinned TFLM / CMSIS / CMSIS-NN / NNABLA / Darknet versions, notes that CMSIS 5 is archived and that CMake only builds tflite-micro and cmsis-nn, adds the missing gemmlowp / KissFFT / Ruy / FlatBuffers pages, documents the kernel AI-engine character driver, adds drivers/aie to CMake, and fixes the aie_register() header comment plus SPDX.

No nuttx-apps change. Depends on current apache/nuttx-apps master (DEPTHWISE already merged).

Impact

Docs-only for applications and drivers, plus a small unused-driver build fix:

  • HTML docs now match tflm_tool.cc and the current Kconfig/Makefile pins
  • CONFIG_AI_ENGINE builds under CMake the same way it already did with Make
  • No runtime or API change for boards that do not enable CONFIG_AI_ENGINE (none in-tree do)

Testing

Host: Linux WSL2 x86_64, gcc 13.3.0, Python 3.11.9, Sphinx 6.2.1
Target: docs + style only (no board image)

  1. checkpatch / nxstyle
$ ./tools/checkpatch.sh -g HEAD
✔️ All checks pass.
$ ./tools/nxstyle include/nuttx/aie/ai_engine.h
$ echo $?
0
$ ./tools/nxstyle drivers/aie/CMakeLists.txt
$ echo $?
0
  1. Docs vs tflm_tool.cc
tflm_tool.cc resolver:
resolver.AddConv2D();
resolver.AddDepthwiseConv2D();
resolver.AddMaxPool2D();
resolver.AddQuantize();
resolver.AddDequantize();
resolver.AddMean();
resolver.AddReshape();
resolver.AddFullyConnected();
resolver.AddSoftmax();
docs nine-ops mention: True
docs DEPTHWISE_CONV_2D: True
docs eight leftover: False
  1. Sphinx HTML (-W, warnings as errors)
$ cd Documentation
$ sphinx-build -j auto -W -b html . _build/html
Running Sphinx v6.2.1
building [html]: targets for 1736 source files that are out of date
updating environment: [new config] 1739 added, 0 changed, 0 removed
...
build succeeded.
The HTML pages are in _build/html.
Generated pages present:

OK  applications/mlearning/tflite-micro/index.html
OK  applications/mlearning/index.html
OK  applications/math/gemmlowp/index.html
OK  applications/math/kissfft/index.html
OK  applications/math/ruy/index.html
OK  applications/system/flatbuffers/index.html
OK  components/drivers/character/aie.html

The tflm tool registered DEPTHWISE_CONV_2D in nuttx-apps#3773, but the
docs still listed eight operators. Document the unused -C compile path,
that the sim helper uses heap I/O, and the pinned TFLM/CMSIS/NNABLA
versions. Add missing gemmlowp, KissFFT, Ruy, and FlatBuffers pages,
document the AI-engine character driver, and wire it into CMake.

Signed-off-by: Abhishek Mishra <mishra.abhishek2808@gmail.com>
@github-actions github-actions Bot added Area: Drivers Drivers issues Size: M The size of the change in this PR is medium labels Sep 19, 2026
@github-actions

Copy link
Copy Markdown

MemBrowse Memory Report

No memory changes detected for:

Comment thread Documentation/applications/math/kissfft/index.rst
@acassis
acassis merged commit b180dc1 into apache:master Sep 19, 2026
54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Drivers Drivers issues Size: M The size of the change in this PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants