Skip to content

Commit 8752431

Browse files
committed
Add placeholder troubleshooting docs
1 parent e62bc67 commit 8752431

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

docs/source/using-executorch-ios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ git clone https://github.com/pytorch/executorch.git --depth 1 --recurse-submodul
106106
python3 -m venv .venv && source .venv/bin/activate && pip install --upgrade pip
107107
```
108108

109-
4. Install the required dependencies, including those needed for the backends like [Core ML](build-run-coreml.md) or [MPS](build-run-mps.md), if you plan to build them as well:
109+
4. Install the required dependencies, including those needed for the backends like [Core ML](backends-coreml.md) or [MPS](backends-mps.md), if you plan to build them as well:
110110

111111
```bash
112112
./install_executorch.sh --pybind coreml mps xnnpack
Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
11
# Profiling and Debugging
22

3-
Placeholder for top-level troubleshooting, profiling, and devtool docs
3+
ExecuTorch
4+
5+
## General Troubleshooting Steps
6+
7+
- To troubleshoot failure of runtime API calls, such as loading or running a model, ensure that ExecuTorch framework logging is enabled. See [Logging](using-executorch-runtime-integration.md#logging) for more information.
8+
- As a prelimatinary step to troubleshoot slow run times, ensure that performance testing is being done in a release build, and that the model is delegated. See [Inference is Slow](using-executorch-faqs.md#inference-is-slow--performance-troubleshooting) for more information.
9+
- Check [Frequently Asked Questions](using-executorch-faqs.md) for common issues and questions encountered during install, model export, and runtime integration.
10+
11+
## Developer Tools
12+
13+
The ExecuTorch developer tools, or devtools, are a collection of tooling for troubleshooting model performance, numerics, and resource utilization. See [Introduction to the ExecuTorch Developer Tools](devtools-overview.md) for an overview of the available developer tools and usage.
14+
15+
## Next Steps
16+
17+
- [Frequently Asked Questions](using-executorch-faqs.md) for solutions to commonly encountered questions and issues.
18+
- [Introduction to the ExecuTorch Developer Tools](runtime-profiling.md) for a high-level introduction to available developer tooling.
19+
- [Using the ExecuTorch Developer Tools to Profile a Model](tutorials/devtools-integration-tutorial.md) for information on runtime performance profiling.
20+
- [Inspector APIs](runtime-profiling.md) for reference material on trace inspector APIs.

0 commit comments

Comments
 (0)