Skip to content

Commit a0e1395

Browse files
authored
Documentation polishing related to delegates (#14551)
Summary: 1. backend-delegates-dependencies.md - fix typos 2. backend-delegates-integration.md - a bit polishing, use bullet point instead of plain text 3. debug-backend-delegate.md - use a real model so users can copy paste, also adapt to the API changes Differential Revision: D83186517
1 parent ebabf52 commit a0e1395

File tree

3 files changed

+586
-40
lines changed

3 files changed

+586
-40
lines changed

docs/source/backend-delegates-dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ for these third-party dependencies.
4949
`executorch/third-party` then try to use that if possible. This
5050
helps with reducing the binary size when the delegate is enabled.
5151
* The rest of the ExecuTorch code, outside of the delegate, should not depend on
52-
this. And it should should build and run correctly without this dependency
52+
this. And it should build and run correctly without this dependency
5353
when the delegate is disabled at build time.
5454

5555
More details in the section [below](#runtime-dependencies).

docs/source/backend-delegates-integration.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@ the top level ExecuTorch package. For third-party dependencies, please refer to
2323
At a minimum, a delegate must provide CMake support for building its C++
2424
sources.
2525

26-
For the CMake setup, the delegate dir should be included by the
27-
top level `CMakeLists.txt` file using `add_subdirectory` CMake command, and
28-
should be built conditionally with an ExecuTorch build flag like
29-
`EXECUTORCH_BUILD_<DELEGATE_NAME>`, see `EXECUTORCH_BUILD_XNNPACK` for example.
30-
For third-party dependencies, please refer to
31-
[this](backend-delegates-dependencies.md).
26+
For the CMake setup:
27+
28+
- The delegate directory should be included by the top-level `CMakeLists.txt` file using the `add_subdirectory` command.
29+
- It should be built conditionally using an ExecuTorch build flag like `EXECUTORCH_BUILD_<DELEGATE_NAME>`.
30+
(See `EXECUTORCH_BUILD_XNNPACK` for an example.)
31+
32+
For third-party dependencies, please refer to [this](backend-delegates-dependencies.md).
3233

3334
<!---
3435
TODO: Add more details. Need to insert a CMake layer in `executorch/backends` to
@@ -49,9 +50,7 @@ Common test types:
4950

5051
## Documentation
5152

52-
A delegate must contain a `executorch/backends/<delegate_name>/README.md`
53-
explaining the basics of the delegate, directory structure, features, and known
54-
issues if any.
53+
A delegate must include:
5554

56-
Any extra setup steps beyond the ones listed above should be documented in
57-
`executorch/backends/<delegate_name>/setup.md`
55+
- `executorch/backends/<delegate_name>/README.md` – covering the basics of the delegate, its directory structure, features, and any known issues.
56+
- `executorch/backends/<delegate_name>/setup.md` – documenting any additional setup steps beyond the ones listed above.

0 commit comments

Comments
 (0)