Skip to content

Commit 8e8058d

Browse files
authored
tutorial for devtool debugibility
Differential Revision: D90809255 Pull Request resolved: pytorch#16735
1 parent cd6c15a commit 8e8058d

6 files changed

Lines changed: 515 additions & 4 deletions

File tree

‎docs/source/devtools-tutorial.md‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1-
## Developer Tools Usage Tutorial
1+
## Developer Tools Usage Tutorials
22

3-
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.
3+
The ExecuTorch Developer Tools provide capabilities for profiling and debugging your models. We provide step-by-step tutorials for common workflows:
4+
5+
### Profiling Tutorial
6+
7+
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:
8+
9+
- Generating ETRecord and ETDump artifacts
10+
- Using the Inspector API to analyze performance data
11+
- Identifying slow operators and bottlenecks
12+
13+
### Debugging Tutorial
14+
15+
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:
16+
17+
- Capturing intermediate outputs with debug buffers
18+
- Using ``calculate_numeric_gap`` to identify precision issues
19+
- Debugging delegated models (e.g., XNNPACK)
20+
- Comparing runtime outputs with eager model references

‎docs/source/model-debugging.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.).
44

5+
For a complete step-by-step walkthrough, please refer to the [Debugging Tutorial](tutorials/devtools-debugging-tutorial). <!-- @lint-ignore -->
6+
57
Currently, ExecuTorch supports the following debugging flows:
68
- Extraction of model level outputs via ETDump.
79
- Extraction of intermediate outputs (outside of delegates) via ETDump:

‎docs/source/model-inspector.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ APIs:
1717
* By accessing the `public attributes <#inspector-attributes>`__ of the ``Inspector``, ``EventBlock``, and ``Event`` classes.
1818
* By using a `CLI <#cli>`__ tool for basic functionalities.
1919

20-
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.
20+
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.
2121

2222

2323
Inspector Methods

0 commit comments

Comments
 (0)