Skip to content

Commit b315a9d

Browse files
committed
Sync list of tutorial cards and left-hand nav section (#922)
Summary: Pull Request resolved: #922 Make sure that the list of tutorials in the left-hand nav section agrees with the set of tutorial cards. Rearrange the tutorials to do more general ones first, then mobile apps (which will probably have a larger audience), then an alphabetical list of backend examples. Reviewed By: mergennachin, kimishpatel Differential Revision: D50302244 fbshipit-source-id: a1431264cfdbb983cf6b9ad116eac83fb70c120e
1 parent 73975bd commit b315a9d

File tree

1 file changed

+65
-20
lines changed

1 file changed

+65
-20
lines changed

docs/source/index.rst

Lines changed: 65 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -88,16 +88,19 @@ Topics in this section will help you get started with ExecuTorch.
8888

8989
tutorials/export-to-executorch-tutorial
9090
running-a-model-cpp-tutorial
91-
examples-end-to-end-to-lower-model-to-delegate
92-
build-run-ios-demo
93-
demo-apps-android
94-
build-run-xtensa
95-
build-run-qualcomm-ai-engine-direct-backend
96-
build-run-mps
97-
build-run-coreml
9891
tutorials/sdk-integration-tutorial
99-
executorch-arm-delegate-tutorial
92+
demo-apps-ios
93+
demo-apps-android
94+
examples-end-to-end-to-lower-model-to-delegate
10095
tutorial-xnnpack-delegate-lowering
96+
..
97+
Alphabetical by backend name. Be sure to keep the same order in the
98+
customcarditem entries below.
99+
executorch-arm-delegate-tutorial
100+
build-run-coreml
101+
build-run-mps
102+
build-run-qualcomm-ai-engine-direct-backend
103+
build-run-xtensa
101104

102105
.. toctree::
103106
:glob:
@@ -202,20 +205,20 @@ ExecuTorch tutorials.
202205
:link: tutorials/export-to-executorch-tutorial.html
203206
:tags: Export,Delegation,Quantization
204207

205-
.. customcarditem::
206-
:header: Using the ExecuTorch SDK to profile a model
207-
:card_description: A tutorial for using the ExecuTorch SDK to profile and analyze a model with linkage back to source code.
208-
:image: _static/img/generic-pytorch-logo.png
209-
:link: tutorials/sdk-integration-tutorial.html
210-
:tags: SDK
211-
212208
.. customcarditem::
213209
:header: Running an ExecuTorch Model C++ Tutorial
214210
:card_description: A tutorial for setting up memory pools, loading a model, setting inputs, executing the model, and retrieving outputs on device.
215211
:image: _static/img/generic-pytorch-logo.png
216212
:link: running-a-model-cpp-tutorial.html
217213
:tags:
218214

215+
.. customcarditem::
216+
:header: Using the ExecuTorch SDK to Profile a Model
217+
:card_description: A tutorial for using the ExecuTorch SDK to profile and analyze a model with linkage back to source code.
218+
:image: _static/img/generic-pytorch-logo.png
219+
:link: tutorials/sdk-integration-tutorial.html
220+
:tags: SDK
221+
219222
.. customcarditem::
220223
:header: Building an ExecuTorch iOS Demo App
221224
:card_description: A demo tutorial that explains how to build ExecuTorch into iOS frameworks and run an iOS app.
@@ -231,17 +234,59 @@ ExecuTorch tutorials.
231234
:tags: Delegation,Android
232235

233236
.. customcarditem::
234-
:header: XNNPACK Backend Delegate Lowering Tutorial
235-
:card_description: A demo tutorial for lowering and export models with the XNNPACK Backend
237+
:header: Lowering a Model as a Delegate
238+
:card_description: An end-to-end example showing how to lower a model as a delegate
239+
:image: _static/img/generic-pytorch-logo.png
240+
:link: examples-end-to-end-to-lower-model-to-delegate.html
241+
:tags: Export,Delegation
242+
243+
..
244+
First-party backends that are good intros for readers.
245+
246+
.. customcarditem::
247+
:header: Building and Running ExecuTorch with XNNPACK Backend
248+
:card_description: A demo tutorial for lowering and exporting models with the XNNPACK Backend
236249
:image: _static/img/generic-pytorch-logo.png
237250
:link: tutorial-xnnpack-delegate-lowering.html
238-
:tags: Export,Delegation,Quantization,XNNPACK
251+
:tags: Export,Backend,Delegation,Quantization,XNNPACK
252+
253+
..
254+
Alphabetical by backend name. Be sure to keep the same order in the Tutorials
255+
toctree entry above.
256+
257+
.. customcarditem::
258+
:header: Building and Running ExecuTorch with ARM Ethos-U Backend
259+
:card_description: A tutorial that walks you through the process of building ExecuTorch with ARM Ethos-U Backend
260+
:image: _static/img/generic-pytorch-logo.png
261+
:link: executorch-arm-delegate-tutorial.html
262+
:tags: Export,Backend,Delegation,ARM,Ethos-U
263+
264+
.. customcarditem::
265+
:header: Building and Running ExecuTorch with CoreML Backend
266+
:card_description: A tutorial that walks you through the process of building ExecuTorch with CoreML Backend
267+
:image: _static/img/generic-pytorch-logo.png
268+
:link: build-run-coreml.html
269+
:tags: Export,Backend,Delegation,CoreML
270+
271+
.. customcarditem::
272+
:header: Building and Running ExecuTorch with MPSGraph Backend
273+
:card_description: A tutorial that walks you through the process of building ExecuTorch with MPSGraph Backend
274+
:image: _static/img/generic-pytorch-logo.png
275+
:link: build-run-mps.html
276+
:tags: Export,Backend,Delegation,MPS,MPSGraph
277+
278+
.. customcarditem::
279+
:header: Building and Running ExecuTorch with Qualcomm AI Engine Direct Backend
280+
:card_description: A tutorial that walks you through the process of building ExecuTorch with Qualcomm AI Engine Direct Backend
281+
:image: _static/img/generic-pytorch-logo.png
282+
:link: build-run-build-run-qualcomm-ai-engine-direct-backend.html
283+
:tags: Export,Backend,Delegation,QNN
239284

240285
.. customcarditem::
241286
:header: Building and Running ExecuTorch on Xtensa HiFi4 DSP
242-
:card_description: A tutorial that walks you through the process of building ExecuTorch for an Xtensa Hifi4 DSP.
287+
:card_description: A tutorial that walks you through the process of building ExecuTorch for an Xtensa Hifi4 DSP using custom operators
243288
:image: _static/img/generic-pytorch-logo.png
244289
:link: build-run-xtensa.html
245-
:tags: DSP
290+
:tags: Export,Custom-Operators,DSP,Xtensa
246291

247292
.. customcardend::

0 commit comments

Comments
 (0)