Skip to content

Commit 931d8d8

Browse files
Fix QA issues of the devtools README (#5998)
Fix QA issues of the devtools README (#5963) Summary: Pull Request resolved: #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 085193e) Co-authored-by: Olivia Liu <[email protected]>
1 parent a9d7182 commit 931d8d8

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

examples/devtools/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ This directory contains examples of BundledProgram and ETDump generation.
66
examples/devtools
77
├── scripts # Python scripts to illustrate export workflow of bundled program.
88
├── executor_runner # Contains an example for both BundledProgram to verify ExecuTorch model, and generate ETDump for runtime results.
9+
├── CMakeLists.txt # Example CMakeLists.txt for building executor_runner with Developer Tools support.
10+
├── build_example_runner.sh # A convenient shell script to build the example_runner.
11+
├── test_example_runner.sh # A convenient shell script to run the example_runner.
912
└── README.md # Current file
1013
```
1114

@@ -46,7 +49,7 @@ python3 -m examples.devtools.scripts.export_bundled_program -m mv2 # for MobileN
4649
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.
4750
We offer an example runner that accepts a `BundledProgram` (`.bpte`) and runs a single iteration over the first method defined.
4851

49-
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.
52+
Running the program will generate an `ETDump` file (`.etdp`) at the location specified by `--etdump_path`.
5053

5154
```bash
5255
./cmake-out/examples/devtools/example_runner --bundled_program_path mv2_bundled.bpte --etdump_path mv2_etdump.etdp

0 commit comments

Comments
 (0)