Skip to content

Documentation polishing related to delegates #14551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 25, 2025
Merged

Documentation polishing related to delegates #14551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/backend-delegates-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ for these third-party dependencies.
`executorch/third-party` then try to use that if possible. This
helps with reducing the binary size when the delegate is enabled.
* The rest of the ExecuTorch code, outside of the delegate, should not depend on
this. And it should should build and run correctly without this dependency
this. And it should build and run correctly without this dependency
when the delegate is disabled at build time.

More details in the section [below](#runtime-dependencies).
Expand Down
21 changes: 10 additions & 11 deletions docs/source/backend-delegates-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@ the top level ExecuTorch package. For third-party dependencies, please refer to
At a minimum, a delegate must provide CMake support for building its C++
sources.

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

- The delegate directory should be included by the top-level `CMakeLists.txt` file using the `add_subdirectory` command.
- It should be built conditionally using an ExecuTorch build flag like `EXECUTORCH_BUILD_<DELEGATE_NAME>`.
(See `EXECUTORCH_BUILD_XNNPACK` for an example.)

For third-party dependencies, please refer to [this](backend-delegates-dependencies.md).

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

## Documentation

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

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