Update docs of moved aot_arm_compiler.py#18943
Update docs of moved aot_arm_compiler.py#18943martinlsm wants to merge 1 commit intopytorch:mainfrom
Conversation
aot_arm_compiler.py has been moved from examples/arm to backends/arm/scripts. Update documentation and scripts invoking this script to use the new path. Signed-off-by: Martin Lindström <Martin.Lindstroem@arm.com> Change-Id: Ia59e751ac3fa1b164c54caa73bcc6d36d454aebb
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/18943
Note: Links to docs will display an error until the docs builds have been completed. ❗ 1 Active SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below: ❌ 1 Awaiting Approval, 28 New Failures, 3 Unrelated FailuresAs of commit 6cea39c with merge base a43675c ( NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following jobs failed but were present on the merge base:👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
@pytorchbot label ciflow/trunk |
|
@pytorchbot label "partner: arm" |
|
@pytorchbot label "release notes: arm" |
There was a problem hiding this comment.
Pull request overview
Updates all documentation and helper scripts to call the Arm AOT compiler from its new location (backends/arm/scripts/aot_arm_compiler.py), keeping Zephyr samples, Arm backend docs, CI scripts, and tests aligned with the move.
Changes:
- Repoint
python -m ...aot_arm_compilerinvocations fromexamples.arm.aot_arm_compilertobackends.arm.scripts.aot_arm_compiler. - Update documentation links/text to reference the new script path.
- Add a shebang to
backends/arm/scripts/aot_arm_compiler.pyto support direct execution.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| zephyr/samples/hello-executorch/models/add.py | Updates comment to reference the new compiler script location. |
| zephyr/samples/hello-executorch/README.md | Updates Zephyr sample commands to use the new module path. |
| examples/arm/run.sh | Updates the AOT compiler module invoked by the runner. |
| examples/arm/example_modules/add.py | Updates header year and comment to reference new compiler location. |
| examples/arm/README.md | Updates documentation examples to call the new module path. |
| docs/source/backends/arm-vgf/tutorials/vgf-getting-started.md | Updates GitHub link and example command to new compiler path. |
| docs/source/backends/arm-ethos-u/tutorials/ethos-u-getting-started.md | Updates GitHub link and example command to new compiler path. |
| backends/arm/test/test_model.py | Updates test helper to invoke the new compiler module path. |
| backends/arm/scripts/docgen/vgf/vgf-getting-started-tutorial.md.in | Updates docgen template links/commands to new compiler path. |
| backends/arm/scripts/docgen/ethos-u/ethos-u-getting-started-tutorial.md.in | Updates docgen template links/commands to new compiler path. |
| backends/arm/scripts/aot_arm_compiler.py | Adds #!/usr/bin/env python3 shebang. |
| backends/arm/README.md | Updates backend README example command to new compiler module path. |
| .ci/scripts/test_cortex_m_e2e.sh | Updates CI e2e script to invoke the new compiler module path. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
aot_arm_compiler.py has been moved from examples/arm to backends/arm/scripts. Update documentation and scripts invoking this script to use the new path.
cc @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils @Sebastian-Larsson @robell