Documentation/applications: add mlearning docs and rename mlearing. - #20050
Merged
xiaoxiang781216 merged 1 commit intoSep 3, 2026
Merged
Conversation
The apps tree is apps/mlearning, but documentation lived under the misspelled mlearing path as title-only stubs. TensorFlow Lite Micro and standalone CMSIS-NN had no pages. Rename the directory to mlearning, document each package from the current Kconfig and build files, and add the sim:tflm board configuration. Assisted-by: Cursor:Grok-4.6 Signed-off-by: Abhishek Mishra <mishra.abhishek2808@gmail.com>
Abhishekmishra2808
requested review from
btashton,
raiden00pl,
tmedicci and
yamt
as code owners
September 3, 2026 04:31
simbit18
approved these changes
Sep 3, 2026
simbit18
requested review from
acassis,
cederom,
jerpelea,
linguini1 and
xiaoxiang781216
September 3, 2026 05:12
xiaoxiang781216
approved these changes
Sep 3, 2026
Contributor
|
Hello @Abhishekmishra2808 thank you very much for this PR, It will help me a lot too. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
apps/mlearning, but the NuttX docs used the misspelledDocumentation/applications/mlearingpath and were title-only stubs.apps/mlearning/tflite-micro) and standalone CMSIS-NN had no documentation at all.mlearning, document each package from the current Kconfig/Makefiles/tflm_tool.cc, and add thesim:tflmboard configuration.Impact
mlearingdoc URLs move tomlearning.Testing
I confirm that changes are verified on local setup and works as intended:
sim:tflmMakefile buildCheckpatch on this commit:
Sphinx documentation build (
Documentation/, warnings as errors):Generated pages include
applications/mlearning/index.htmlandapplications/mlearning/tflite-micro/index.html.sim:tflmconfigure and Makefile build (original logs):