Skip to content

Commit 14c252b

Browse files
authored
Merge branch 'main' into fix_logging
2 parents 3366aa1 + 39274d8 commit 14c252b

20 files changed

+27
-69
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ executorch
5858
│ ├── <a href="exir/verification">verification</a> - IR verification.
5959
├── <a href="extension">extension</a> - Extensions built on top of the runtime.
6060
│ ├── <a href="extension/android">android</a> - ExecuTorch wrappers for Android apps. Please refer to the <a href="docs/source/using-executorch-android.md">Android documentation</a> and <a href="https://pytorch.org/executorch/main/javadoc/">Javadoc</a> for more information.
61-
│ ├── <a href="extension/apple">apple</a> - ExecuTorch wrappers for iOS apps. Please refer to the <a href="docs/source/using-executorch-ios.md">iOS documentation</a> and <a href="https://pytorch.org/executorch/stable/apple-runtime.html">how to integrate into Apple platform</a> for more information.
61+
│ ├── <a href="extension/apple">apple</a> - ExecuTorch wrappers for iOS apps. Please refer to the <a href="docs/source/using-executorch-ios.md">iOS documentation</a> and <a href="https://pytorch.org/executorch/main/using-executorch-ios.html">how to integrate into Apple platform</a> for more information.
6262
│ ├── <a href="extension/aten_util">aten_util</a> - Converts to and from PyTorch ATen types.
6363
│ ├── <a href="extension/data_loader">data_loader</a> - 1st party data loader implementations.
6464
│ ├── <a href="extension/evalue_util">evalue_util</a> - Helpers for working with EValue objects.

docs/source/build-run-openvino.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For more information about OpenVINO build, refer to the [OpenVINO Build Instruct
6161

6262
Follow the steps below to setup your build environment:
6363

64-
1. **Setup ExecuTorch Environment**: Refer to the [Environment Setup](https://pytorch.org/executorch/stable/getting-started-setup#environment-setup) guide for detailed instructions on setting up the ExecuTorch environment.
64+
1. **Setup ExecuTorch Environment**: Refer to the [Environment Setup](getting-started-setup.md#environment-setup) guide for detailed instructions on setting up the ExecuTorch environment.
6565

6666
2. **Setup OpenVINO Backend Environment**
6767
- Install the dependent libs. Ensure that you are inside `executorch/backends/openvino/` directory
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Memory Planning Inspection in ExecuTorch
22

3-
After the [Memory Planning](https://pytorch.org/executorch/main/concepts.html#memory-planning) pass of ExecuTorch, memory allocation information is stored on the nodes of the [`ExportedProgram`](https://pytorch.org/executorch/main/concepts.html#exportedprogram). Here, we present a tool designed to inspect memory allocation and visualize all active tensor objects.
3+
After the [Memory Planning](concepts.md#memory-planning) pass of ExecuTorch, memory allocation information is stored on the nodes of the [`ExportedProgram`](concepts.md#exportedprogram). Here, we present a tool designed to inspect memory allocation and visualize all active tensor objects.
44

55
## Usage
6-
User should add this code after they call [to_executorch()](https://pytorch.org/executorch/main/export-to-executorch-api-reference.html#executorch.exir.EdgeProgramManager.to_executorch), and it will write memory allocation information stored on the nodes to the file path "memory_profile.json". The file is compatible with the Chrome trace viewer; see below for more information about interpreting the results.
6+
User should add this code after they call [to_executorch()](export-to-executorch-api-reference.rst#executorch.exir.EdgeProgramManager.to_executorch), and it will write memory allocation information stored on the nodes to the file path "memory_profile.json". The file is compatible with the Chrome trace viewer; see below for more information about interpreting the results.
77

88
```python
99
from executorch.util.activation_memory_profiler import generate_memory_trace
@@ -13,18 +13,18 @@ generate_memory_trace(
1313
enable_memory_offsets=True,
1414
)
1515
```
16-
* `prog` is an instance of [`ExecuTorchProgramManager`](https://pytorch.org/executorch/main/export-to-executorch-api-reference.html#executorch.exir.ExecutorchProgramManager), returned by [to_executorch()](https://pytorch.org/executorch/main/export-to-executorch-api-reference.html#executorch.exir.EdgeProgramManager.to_executorch).
16+
* `prog` is an instance of [`ExecuTorchProgramManager`](export-to-executorch-api-reference.rst#executorch.exir.ExecutorchProgramManager), returned by [to_executorch()](export-to-executorch-api-reference.rst#executorch.exir.EdgeProgramManager.to_executorch).
1717
* Set `enable_memory_offsets` to `True` to show the location of each tensor on the memory space.
1818

1919
## Chrome Trace
2020
Open a Chrome browser tab and navigate to <chrome://tracing/>. Upload the generated `.json` to view.
2121
Example of a [MobileNet V2](https://pytorch.org/vision/main/models/mobilenetv2.html) model:
2222

23-
![Memory planning Chrome trace visualization](/_static/img/memory_planning_inspection.png)
23+
![Memory planning Chrome trace visualization](_static/img/memory_planning_inspection.png)
2424

2525
Note that, since we are repurposing the Chrome trace tool, the axes in this context may have different meanings compared to other Chrome trace graphs you may have encountered previously:
2626
* The horizontal axis, despite being labeled in seconds (s), actually represents megabytes (MBs).
2727
* The vertical axis has a 2-level hierarchy. The first level, "pid", represents memory space. For CPU, everything is allocated on one "space"; other backends may have multiple. In the second level, each row represents one time step. Since nodes will be executed sequentially, each node represents one time step, thus you will have as many nodes as there are rows.
2828

2929
## Further Reading
30-
* [Memory Planning](https://pytorch.org/executorch/main/compiler-memory-planning.html)
30+
* [Memory Planning](compiler-memory-planning.md)

docs/source/new-contributor-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Before you can start writing any code, you need to get a copy of ExecuTorch code
129129
git push # push updated local main to your GitHub fork
130130
```
131131

132-
6. [Build the project](https://pytorch.org/executorch/main/using-executorch-building-from-source.html) and [run the tests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#testing).
132+
6. [Build the project](using-executorch-building-from-source.md) and [run the tests](https://github.com/pytorch/executorch/blob/main/CONTRIBUTING.md#testing).
133133

134134
Unfortunately, this step is too long to detail here. If you get stuck at any point, please feel free to ask for help on our [Discord server](https://discord.com/invite/Dh43CKSAdc) — we're always eager to help newcomers get onboarded.
135135

docs/source/sdk-bundled-io.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/source/sdk-debugging.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/source/sdk-delegate-integration.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/source/sdk-etdump.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/source/sdk-etrecord.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/source/sdk-inspector.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)