From daedeb6d9df31a8a63c55a0d5a92661399c572a9 Mon Sep 17 00:00:00 2001 From: Olivia Liu Date: Tue, 8 Oct 2024 10:55:05 -0700 Subject: [PATCH] Fix QA issues of the devtools README (#5963) Summary: Pull Request resolved: https://github.com/pytorch/executorch/pull/5963 Add new files in the "Directory structure". And also remove an old statement. Since `-DEXECUTORCH_BUILD_DEVTOOLS=ON` is set in the build_example_runner.sh, and not in a command in the readme, so it no longer makes sense to call it out in this readme. Reviewed By: Gasoonjia Differential Revision: D64017662 fbshipit-source-id: 1ee8b086180c7f995ff3306ebceb4afcff934214 (cherry picked from commit 085193e7e2724718148153e67c604e9c712dd0d1) --- examples/devtools/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/examples/devtools/README.md b/examples/devtools/README.md index c06d3eac3fc..e4fbadfcca0 100644 --- a/examples/devtools/README.md +++ b/examples/devtools/README.md @@ -6,6 +6,9 @@ This directory contains examples of BundledProgram and ETDump generation. examples/devtools ├── scripts # Python scripts to illustrate export workflow of bundled program. ├── executor_runner # Contains an example for both BundledProgram to verify ExecuTorch model, and generate ETDump for runtime results. +├── CMakeLists.txt # Example CMakeLists.txt for building executor_runner with Developer Tools support. +├── build_example_runner.sh # A convenient shell script to build the example_runner. +├── test_example_runner.sh # A convenient shell script to run the example_runner. └── README.md # Current file ``` @@ -46,7 +49,7 @@ python3 -m examples.devtools.scripts.export_bundled_program -m mv2 # for MobileN After exporting a `BundledProgram`, runtime profiling and debug data can be collected in an ``ETDump``. An ``ETDump`` is a buffer containing data generated by hooks within the ExecuTorch runtime. We offer an example runner that accepts a `BundledProgram` (`.bpte`) and runs a single iteration over the first method defined. -Running the program will generate an `ETDump` file (`.etdp`) at the location specified by `--etdump_path`. Make sure to build the program as specified below to enable the event tracer. +Running the program will generate an `ETDump` file (`.etdp`) at the location specified by `--etdump_path`. ```bash ./cmake-out/examples/devtools/example_runner --bundled_program_path mv2_bundled.bpte --etdump_path mv2_etdump.etdp