Add example for Espressif ESP32 executorch runner with no optimizations#18224
Add example for Espressif ESP32 executorch runner with no optimizations#18224jpiat wants to merge 16 commits intopytorch:mainfrom
Conversation
…e it included in runner
…play correct error messages
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/18224
Note: Links to docs will display an error until the docs builds have been completed. ❌ 10 Awaiting Approval, 1 New FailureAs of commit 34a42c7 with merge base c81126e ( AWAITING APPROVAL - The following workflows need approval before CI can run:
NEW FAILURE - The following job has failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
Hi @jpiat! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
There was a problem hiding this comment.
Pull request overview
Adds an Espressif (ESP32 / ESP32-S3) ExecuTorch “executor runner” example project plus a new CMake preset to help cross-compile ExecuTorch for ESP targets.
Changes:
- Introduces a new
esp-baremetalCMake preset and preset file for ESP-oriented ExecuTorch builds. - Adds a full ESP-IDF example project (runner component + template project + build script + docs).
- Adds ESP-IDF configuration defaults (sdkconfig defaults + partition table) for ESP32-S3-oriented setups.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/cmake/preset/esp_baremetal.cmake | New ESP-oriented ExecuTorch build preset settings. |
| CMakePresets.json | Registers the esp-baremetal configure preset. |
| examples/espressif/README.md | End-to-end instructions for exporting, building, flashing, and troubleshooting on ESP32/ESP32-S3. |
| examples/espressif/build.sh | Helper script to build the ESP-IDF project and optionally generate model_pte.h. |
| examples/espressif/executor_runner/CMakeLists.txt | ESP-IDF component + standalone build definition for the runner. |
| examples/espressif/executor_runner/esp_executor_runner.cpp | Main ESP runner implementation (PAL hooks, loading, execution, optional FS load/ETDump/BundleIO). |
| examples/espressif/executor_runner/esp_memory_allocator.{h,cpp} | ESP-specific allocator wrapper with usage tracking. |
| examples/espressif/executor_runner/esp_perf_monitor.{h,cpp} | Simple perf measurements using cycle counter + esp_timer. |
| examples/espressif/executor_runner/pte_to_header.py | Converts .pte into a C header for compiled-in model embedding. |
| examples/espressif/project/CMakeLists.txt | Template ESP-IDF project that pulls in the runner component. |
| examples/espressif/project/main/{CMakeLists.txt,main.cpp} | Minimal “main” component that calls into the runner. |
| examples/espressif/project/sdkconfig.defaults | Default ESP-IDF configuration for the example (generic). |
| examples/espressif/project/sdkconfig.defaults.esp32s3 | Target-specific ESP32-S3 config defaults. |
| examples/espressif/project/partitions.csv | Custom partition table for the example firmware. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
@pytorchbot label "release notes: examples" |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a new Espressif ESP32/ESP32-S3 example integration for running ExecuTorch models under ESP-IDF, along with build tooling and documentation to cross-compile ExecuTorch for Xtensa and build/flash an example project.
Changes:
- Introduces an ESP-IDF
executor_runnercomponent and example project scaffolding (CMake,app_main, sdkconfig defaults, partitions). - Adds an ESP-focused CMake preset (
esp-baremetal) to configure ExecuTorch builds for the target. - Adds a model conversion helper (
pte_to_header.py), a build helper script, and a comprehensive README.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/cmake/preset/esp_baremetal.cmake | New preset to configure ExecuTorch build options for ESP targets. |
| CMakePresets.json | Registers the esp-baremetal CMake preset. |
| examples/espressif/README.md | End-to-end documentation for exporting, building, flashing, and troubleshooting. |
| examples/espressif/build.sh | Helper script to generate model_pte.h and build via idf.py. |
| examples/espressif/executor_runner/CMakeLists.txt | ESP-IDF component definition + standalone CMake build option; integrates prebuilt ExecuTorch libs. |
| examples/espressif/executor_runner/esp_executor_runner.cpp | Core runner implementation: loading PTE, setting up allocators, executing, logging, optional SPIFFS load. |
| examples/espressif/executor_runner/esp_memory_allocator.{h,cpp} | Custom allocator wrapper with tracking helpers. |
| examples/espressif/executor_runner/esp_perf_monitor.{h,cpp} | Perf measurement helpers using cycle counter and esp_timer. |
| examples/espressif/executor_runner/pte_to_header.py | Converts a .pte into a C header byte array for firmware embedding. |
| examples/espressif/project/CMakeLists.txt | Example ESP-IDF project top-level CMake. |
| examples/espressif/project/main/CMakeLists.txt | Minimal main component that depends on executor_runner. |
| examples/espressif/project/main/main.cpp | Provides app_main() that invokes executor_runner_main(). |
| examples/espressif/project/sdkconfig.defaults | Baseline ESP-IDF defaults for the example project. |
| examples/espressif/project/sdkconfig.defaults.esp32s3 | ESP32-S3-specific defaults (PSRAM, etc.). |
| examples/espressif/project/partitions.csv | Custom partition table template for the example project. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
…atching result type
There was a problem hiding this comment.
Pull request overview
This pull request adds an Espressif ESP32/ESP32-S3 ExecuTorch “executor runner” example plus a CMake preset to support cross-compiling ExecuTorch for ESP targets.
Changes:
- Introduces a new
esp-baremetalCMake preset and preset file to configure an ESP-oriented ExecuTorch build. - Adds a full ESP-IDF example project + build script + documentation for running
.ptemodels on ESP32/ESP32-S3. - Adds ESP-specific runtime utilities (performance monitor, memory allocator) and an ESP executor runner implementation.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/cmake/preset/esp_baremetal.cmake | New preset file defining default ExecuTorch build toggles for ESP builds. |
| CMakePresets.json | Adds esp-baremetal configure preset entry. |
| extension/threadpool/threadpool.cpp | Adjusts TSAN thread limit constant type in get_threadpool(). |
| examples/espressif/README.md | New end-to-end documentation for ESP32/ESP32-S3 runner and workflow. |
| examples/espressif/build.sh | New helper script to generate model_pte.h and build the ESP-IDF project. |
| examples/espressif/executor_runner/CMakeLists.txt | Defines ESP-IDF component + standalone build wiring for the runner. |
| examples/espressif/executor_runner/esp_executor_runner.cpp | Main ESP runner implementation (PAL hooks, allocators, optional FS load, execution loop). |
| examples/espressif/executor_runner/esp_memory_allocator.h | Declares a tracking allocator wrapper for embedded diagnostics. |
| examples/espressif/executor_runner/esp_memory_allocator.cpp | Implements tracking allocator accounting. |
| examples/espressif/executor_runner/esp_perf_monitor.h | Declares ESP timing/profiling helpers. |
| examples/espressif/executor_runner/esp_perf_monitor.cpp | Implements cycle/time measurement + logging for ESP builds (stubbed for non-ESP). |
| examples/espressif/executor_runner/pte_to_header.py | Utility to convert .pte into a compiled-in C header. |
| examples/espressif/project/CMakeLists.txt | Template ESP-IDF project using the runner component via EXTRA_COMPONENT_DIRS. |
| examples/espressif/project/main/CMakeLists.txt | Minimal main component definition for the ESP-IDF app. |
| examples/espressif/project/main/main.cpp | ESP-IDF app_main() that calls executor_runner_main(). |
| examples/espressif/project/sdkconfig.defaults | Baseline ESP-IDF config defaults for the example. |
| examples/espressif/project/sdkconfig.defaults.esp32s3 | ESP32-S3 specific ESP-IDF config defaults (PSRAM/oct mode, etc.). |
| examples/espressif/project/partitions.csv | Custom partition table for the example project. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
Adds an Espressif ESP32/ESP32-S3 executor runner example and build scaffolding to cross-compile and run ExecuTorch on ESP-IDF targets, plus a small threadpool type tweak and a new CMake preset for ESP baremetal builds.
Changes:
- Add a full ESP-IDF example project/component for running ExecuTorch models on ESP32/ESP32-S3 (runner, perf monitor, allocator, build script, docs, sdkconfigs, partition table).
- Add an
esp-baremetalCMake preset and corresponding preset file for cross-compiling ExecuTorch for ESP targets. - Adjust threadpool TSAN thread-limit constant type to match the detected thread-count type.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/cmake/preset/esp_baremetal.cmake | New build preset configuration for ESP baremetal/cross builds. |
| CMakePresets.json | Registers esp-baremetal configure preset. |
| extension/threadpool/threadpool.cpp | Uses decltype(result) for TSAN thread-limit constant type alignment. |
| examples/espressif/README.md | ESP32/ESP32-S3 usage and build instructions. |
| examples/espressif/build.sh | Helper script to generate model header and build via idf.py. |
| examples/espressif/project/CMakeLists.txt | ESP-IDF example project wiring and component path setup. |
| examples/espressif/project/main/CMakeLists.txt | ESP-IDF main component registering main.cpp. |
| examples/espressif/project/main/main.cpp | Example app_main() that calls executor_runner_main(). |
| examples/espressif/project/sdkconfig.defaults | Default ESP-IDF config for the example. |
| examples/espressif/project/sdkconfig.defaults.esp32s3 | ESP32-S3-specific defaults (Octal PSRAM, etc.). |
| examples/espressif/project/partitions.csv | Example partition table for the ESP-IDF project. |
| examples/espressif/executor_runner/CMakeLists.txt | ESP-IDF component definition + linkage to prebuilt ExecuTorch libs; optional ETDump/BundleIO. |
| examples/espressif/executor_runner/esp_executor_runner.cpp | Core ESP runner implementation (PAL hooks, memory pools, model loading, execution loop). |
| examples/espressif/executor_runner/esp_perf_monitor.h | Perf monitor API for cycle/time measurement. |
| examples/espressif/executor_runner/esp_perf_monitor.cpp | Perf monitor implementation using ESP-IDF timers/cycle counter. |
| examples/espressif/executor_runner/esp_memory_allocator.h | Instrumented allocator wrapper for tracking used/free bytes. |
| examples/espressif/executor_runner/esp_memory_allocator.cpp | Implementation of tracked allocator. |
| examples/espressif/executor_runner/pte_to_header.py | Utility to convert .pte into a compiled-in C header array. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| #include <stdio.h> | ||
| #include "sdkconfig.h" | ||
| #include "freertos/FreeRTOS.h" | ||
| #include "esp_system.h" | ||
|
|
||
| extern void executor_runner_main(void); | ||
|
|
||
| extern "C" void app_main(void) { | ||
| printf("Starting executorch runner !\n"); | ||
| fflush(stdout); | ||
| // Custom initialization here | ||
| executor_runner_main(); | ||
| for (int i = 5; i >= 0; i--) { | ||
| vTaskDelay(1000 / portTICK_PERIOD_MS); | ||
| } |
| uint64_t start_cycle_count = 0; | ||
| int64_t start_time_us = 0; | ||
|
|
||
| } // namespace | ||
|
|
||
| void StartMeasurements() { | ||
| start_cycle_count = esp_cpu_get_cycle_count(); | ||
| start_time_us = esp_timer_get_time(); | ||
| } | ||
|
|
||
| void StopMeasurements(int num_inferences) { | ||
| uint64_t end_cycle_count = esp_cpu_get_cycle_count(); | ||
| int64_t end_time_us = esp_timer_get_time(); | ||
|
|
||
| uint64_t total_cycles = end_cycle_count - start_cycle_count; | ||
| int64_t total_time_us = end_time_us - start_time_us; |
| // Load model from filesystem | ||
| // Use a temporary allocator for the file loading | ||
| EspMemoryAllocator file_allocator( | ||
| method_allocation_pool_size, method_allocation_pool); | ||
| auto [buffer, buffer_size] = | ||
| load_file_from_fs("/spiffs/model.pte", file_allocator); | ||
| if (buffer == nullptr) { | ||
| ET_LOG(Fatal, "Failed to load model from filesystem."); | ||
| return; | ||
| } | ||
| model_pte = buffer; | ||
| model_pte_size = buffer_size; | ||
| pte_size = buffer_size; |
| auto read_size = fread(buffer, 1, size, fp); | ||
| if (read_size != size) { | ||
| ET_LOG( | ||
| Info, | ||
| "Partial read of %s: got %lu of %lu bytes", | ||
| filepath, | ||
| static_cast<unsigned long>(read_size), | ||
| static_cast<unsigned long>(size)); | ||
| } | ||
| fclose(fp); | ||
| return std::make_pair(buffer, read_size); | ||
| } |
|
|
||
| #if defined(ET_LOG_DUMP_INPUT) | ||
| { | ||
| std::vector<EValue> inputs((*ctx.method.value())->inputs_size()); |
| const char* etdump_filename = "/spiffs/etdump.bin"; | ||
| ET_LOG(Info, "Writing etdump to file: %s", etdump_filename); | ||
| FILE* f = fopen(etdump_filename, "w+"); | ||
| if (f) { | ||
| fwrite((uint8_t*)result.buf, 1, result.size, f); | ||
| fclose(f); | ||
| } else { | ||
| ET_LOG(Error, "Could not open %s for writing", etdump_filename); | ||
| } |
| if args.section == "none": | ||
| # No section attribute - let the linker/compiler decide placement. | ||
| # On ESP32 with PSRAM, the compiler/linker or EXT_RAM_BSS_ATTR | ||
| # in the code handles placement. | ||
| attr = "__attribute__((aligned(16))) const unsigned char " | ||
| else: | ||
| attr = f'__attribute__((section("{args.section}"), aligned(16))) const unsigned char ' | ||
| if not os.path.exists(args.outdir): | ||
| os.makedirs(args.outdir) | ||
| with open(args.pte, "rb") as fr, open(outfile, "w") as fw: | ||
| data = fr.read() | ||
| hexstream = binascii.hexlify(data).decode("utf-8") | ||
|
|
||
| fw.write( | ||
| "/* Auto-generated model header for ESP32 ExecuTorch runner. */\n" | ||
| ) | ||
| fw.write(f"/* Source: {os.path.basename(args.pte)} ({len(data)} bytes) */\n\n") | ||
| fw.write("#pragma once\n\n") | ||
| fw.write(attr + "model_pte[] = {") | ||
|
|
| | Chip | CPU | Internal SRAM | PSRAM (optional) | | ||
| |----------|---------------|---------------|------------------| | ||
| | ESP32 | Xtensa LX6 (dual-core, 240MHz) | ~520KB | 4-8MB | | ||
| | ESP32-S3 | Xtensa LX7 (dual-core, 240MHz) | ~512KB | 2-32MB (Octal) | |
Summary
This PR introduce a new example for the ESP32 Espressif SoC. The example implement an executorch runner for the ESP32 platform and a project that executes a simple network. The example does not use ops optimized for ESP32 platform but demonstrate feasibility.
Test plan
This example was tested on a ESP32-S3 development platform. The project compiles and when loaded on the platform show the expected log trace.
cc @psiddh @AdrianLundell @digantdesai