Skip to content

Commit 1379b98

Browse files
committed
Minor cleanup
1 parent baaeab7 commit 1379b98

File tree

9 files changed

+55
-48
lines changed

9 files changed

+55
-48
lines changed

docs/source/backends/template/backend-overview.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,18 @@ This section is intended to tell the user all of the steps they'll need to take
2727

2828
## Reference
2929

30-
**→{doc}`backend-troubleshooting` — Debug common issues.**
31-
3230
**→{doc}`backend-partitioner` — Partitioner options.**
3331

3432
**→{doc}`backend-quantization` — Supported quantization schemes.**
3533

36-
**→{doc}`backend-op-support`Supported operators.**
34+
**→{doc}`backend-troubleshooting`Debug common issues.**
3735

3836
**→{doc}`backend-arch-internals` — Backend internals.**
3937

38+
**→{doc}`tutorials/backend-tutorials` — Tutorials.**
39+
40+
**→{doc}`guides/backend-guides` — Tutorials.**
41+
4042
```{toctree}
4143
:maxdepth: 2
4244
:hidden:
@@ -47,3 +49,5 @@ backend-partitioner
4749
backend-quantization
4850
backend-op-support
4951
backend-arch-internals
52+
tutorials/backend-tutorials
53+
guides/backend-guides

docs/source/backends/template/backend-partitioner.md

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

docs/source/backends/template/backend-op-support.rst renamed to docs/source/backends/template/backend-partitioner.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
==========================
2+
{BACKEND_NAME} Partitioner API
3+
==========================
4+
5+
Document the partitioner API for the backend, including configuration options and compile specs.
6+
7+
- ``option1``: Description of the option and values.
8+
- ``option2``: Description of the second option.
9+
- ``option3``: Description of the third option.
10+
11+
{ADDITIONAL_PARTITIONER_DETAILS}
12+
113
================
214
Operator Support
315
================
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# {BACKEND_NAME} Guides
2+
3+
**→{doc}`{backend_name}-basic-guide` — Guide description.**
4+
5+
```{toctree}
6+
:hidden:
7+
:maxdepth: 1
8+
9+
{backend_name}-basic-guides
10+
```

docs/source/backends/template/guides/backend-tutorials.md

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

docs/source/backends/xnnpack/xnnpack-op-support.rst

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

docs/source/backends/xnnpack/xnnpack-overview.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,21 +82,18 @@ No additional steps are necessary to use the backend beyond linking the target.
8282

8383
**→{doc}`xnnpack-troubleshooting` — Debug common issues.**
8484

85-
**→{doc}`xnnpack-partitioner` — Partitioner options.**
85+
**→{doc}`xnnpack-partitioner` — Partitioner options and supported operators.**
8686

8787
**→{doc}`xnnpack-quantization` — Supported quantization schemes.**
8888

89-
**→{doc}`xnnpack-op-support` — Supported operators.**
90-
9189
**→{doc}`xnnpack-arch-internals` — XNNPACK backend internals.**
9290

9391
```{toctree}
9492
:maxdepth: 2
9593
:hidden:
9694
:caption: XNNPACK Backend
9795
98-
xnnpack-troubleshooting
9996
xnnpack-partitioner
10097
xnnpack-quantization
101-
xnnpack-op-support
98+
xnnpack-troubleshooting
10299
xnnpack-arch-internals

docs/source/backends/xnnpack/xnnpack-partitioner.md

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
===============
2+
Partitioner API
3+
===============
4+
5+
The XNNPACK partitioner API allows for configuration of the model delegation to XNNPACK. Passing an ``XnnpackPartitioner`` instance with no additional parameters will run as much of the model as possible on the XNNPACK backend. This is the most common use-case. For advanced use cases, the partitioner exposes the following options via the `constructor <https://github.com/pytorch/executorch/blob/release/0.6/backends/xnnpack/partition/xnnpack_partitioner.py#L31>`_:
6+
7+
- ``configs``: Control which operators are delegated to XNNPACK. By default, all available operators all delegated. See `../config/__init__.py <https://github.com/pytorch/executorch/blob/release/0.6/backends/xnnpack/partition/config/__init__.py#L66>`_ for an exhaustive list of available operator configs.
8+
- ``config_precisions``: Filter operators by data type. By default, delegate all precisions. One or more of ``ConfigPrecisionType.FP32``, ``ConfigPrecisionType.STATIC_QUANT``, or ``ConfigPrecisionType.DYNAMIC_QUANT``. See `ConfigPrecisionType <https://github.com/pytorch/executorch/blob/release/0.6/backends/xnnpack/partition/config/xnnpack_config.py#L24>`_.
9+
- ``per_op_mode``: If true, emit individual delegate calls for every operator. This is an advanced option intended to reduce memory overhead in some contexts at the cost of a small amount of runtime overhead. Defaults to false.
10+
- ``verbose``: If true, print additional information during lowering.
11+
12+
================
13+
Operator Support
14+
================
15+
16+
This section lists the operators supported by the XNNPACK backend. Operators are the building blocks of the ML model. See `IRs <https://docs.pytorch.org/docs/stable/torch.compiler_ir.html>`_ for more information on the PyTorch operator set.
17+
18+
All operators support dynamic input shapes unless otherwise noted.
19+
20+
.. csv-table:: Operator Support
21+
:file: op-support.csv
22+
:header-rows: 1
23+
:widths: 20 15 30 30
24+
:align: center

0 commit comments

Comments
 (0)