Skip to content

tutorial for devtool debugibility #16735

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

Merged
meta-codesync merged 1 commit into from
Jan 22, 2026
+515 −4
Merged

tutorial for devtool debugibility #16735

Show file tree
Hide file tree
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
21 changes: 19 additions & 2 deletions docs/source/devtools-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## Developer Tools Usage Tutorial
## Developer Tools Usage Tutorials

Please refer to the [Developer Tools tutorial](tutorials/devtools-integration-tutorial) <!-- @lint-ignore --> for a walkthrough on how to profile a model in ExecuTorch using the Developer Tools.
The ExecuTorch Developer Tools provide capabilities for profiling and debugging your models. We provide step-by-step tutorials for common workflows:

### Profiling Tutorial

Please refer to the [Profiling Tutorial](tutorials/devtools-integration-tutorial) <!-- @lint-ignore --> for a walkthrough on how to profile a model in ExecuTorch using the Developer Tools. This tutorial covers:

- Generating ETRecord and ETDump artifacts
- Using the Inspector API to analyze performance data
- Identifying slow operators and bottlenecks

### Debugging Tutorial

Please refer to the [Debugging Tutorial](tutorials/devtools-debugging-tutorial) <!-- @lint-ignore --> for a walkthrough on how to debug numerical discrepancies in ExecuTorch models. This tutorial covers:

- Capturing intermediate outputs with debug buffers
- Using ``calculate_numeric_gap`` to identify precision issues
- Debugging delegated models (e.g., XNNPACK)
- Comparing runtime outputs with eager model references
2 changes: 2 additions & 0 deletions docs/source/model-debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

With the ExecuTorch Developer Tools, users can debug their models for numerical inaccurcies and extract model outputs from their device to do quality analysis (such as Signal-to-Noise, Mean square error etc.).

For a complete step-by-step walkthrough, please refer to the [Debugging Tutorial](tutorials/devtools-debugging-tutorial). <!-- @lint-ignore -->

Currently, ExecuTorch supports the following debugging flows:
- Extraction of model level outputs via ETDump.
- Extraction of intermediate outputs (outside of delegates) via ETDump:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/model-inspector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ APIs:
* By accessing the `public attributes <#inspector-attributes>`__ of the ``Inspector``, ``EventBlock``, and ``Event`` classes.
* By using a `CLI <#cli>`__ tool for basic functionalities.

Please refer to the `e2e use case doc <tutorials/devtools-integration-tutorial.html>`__ get an understanding of how to use these in a real world example.
Please refer to the `e2e use case doc <tutorials/devtools-integration-tutorial.html>`__ to get an understanding of how to use these for profiling, or the `debugging tutorial <tutorials/devtools-debugging-tutorial.html>`__ for debugging numerical discrepancies.


Inspector Methods
Expand Down
Loading
Loading