Skip to content

Fix QA issues of the devtools README #5963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Fix QA issues of the devtools README #5963

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion examples/devtools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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
Expand Down
Loading