Skip to content

Commit 5d36c7c

Browse files
NXP backend: Improve docs for NXP eIQ Neutron Kernel Selective Kernel… (#19772)
… Registration ### Summary Docs improvement. ### Test plan Docs only. cc @robert-kalmar @JakeStevens @digantdesai @rascani
1 parent 50ee05e commit 5d36c7c

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

docs/source/backends/nxp/nxp-kernel-selection.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# NXP eIQ Neutron Kernel Selective Kernel Registration
22

3-
The NXP ExecuTorch backend supports selective Neutron kernel registration for `Neutron-C` targets, which decreases the
3+
The NXP ExecuTorch backend supports selective Neutron kernel registration for `Neutron-C` targets, which reduces the
44
size of the Neutron Firmware. During the backend's conversion to the Neutron representation by the Neutron Converter,
55
microcode for the Neutron accelerator is generated.
66
The microcode consists of kernel calls executed by the Neutron Driver. The code for kernel call functions is
7-
distributed in Neutron Firmware.
7+
distributed in the Neutron Firmware.
88

9-
The `eiq_neutron_sdk.neutron_converter` optionally generates the `*_kernel_selection.c` file, registering
10-
only kernels that are required for a particular model or in the case of ExecuTorch, a delegated subgraph. This
11-
`*_kernel_selection.c`, when used during the application linking, takes precedence over the default list of registered
9+
The `eiq_neutron_sdk.neutron_converter` optionally generates a `*_kernel_selection.c` file, registering
10+
only kernels that are required for a particular model or, in the case of ExecuTorch, a delegated subgraph. This
11+
`*_kernel_selection.c`, when used during application linking, takes precedence over the default list of registered
1212
kernels in the Neutron Firmware, and allows the linker to include only the necessary Neutron kernels.
13-
This software is required for deployment on an edge device (e.g. `i.MXRT700`) and is
14-
distributed via the MCUXpresso SDK. The MCUXpresso SDK enables building of a final application that is then flashed on
13+
The Neutron Firmware is required for deployment on an edge device (e.g. `i.MX RT700`) and is
14+
distributed via the MCUXpresso SDK. The MCUXpresso SDK enables the building of a final application that is then flashed on
1515
the edge device. For more details about this process, see
1616
[eIQ ExecuTorch Library User Guide](https://mcuxpresso.nxp.com/mcuxsdk/latest/html/middleware/eiq/executorch/docs/nxp/ugindex.html).
1717

18-
By default, for Neutron-C targets like `i.MXRT700`, all kernel implementations are present in the Neutron Firmware, which
18+
By default, for Neutron-C targets like `i.MX RT700`, all kernel implementations are present in the Neutron Firmware, which
1919
is linked to the final application. This enables an easy build process for any model, but increases the size of the
20-
final application with unused code. In the case of limited RAM, you can link only kernels that are used in the set of
21-
models deployed. This way you can reduce the size of the final app by linking only selected kernels, used in one or
22-
multiple models.
20+
final application with unused code. In memory-constrained environments, you can link only the kernels required by the
21+
deployed models. This way you can reduce the size of the final application by linking only selected kernels, used in one
22+
or more models.
2323

2424
The feature works as follows: The Neutron Converter with the appropriate flag exports a kernel selection file for each
2525
converted subgraph, the kernel selection files are then merged and ready to be included in the MCUXpresso SDK to use for
@@ -30,7 +30,7 @@ a selection-only build.
3030
3131
## Export kernel selection file
3232

33-
To turn on this feature on the side of NXP ExecuTorch backend, use the parameter `--dump_kernel_selection_code` in
33+
To enable this feature in the NXP ExecuTorch backend, use the parameter `--dump_kernel_selection_code` in
3434
`aot_neutron_compile.py`. An example with the CifarNet model:
3535

3636
```commandline
@@ -43,7 +43,7 @@ This command will create a `*_kernel_selection.c` file alongside the converted P
4343

4444
## Kernel Registration for Multiple Models
4545

46-
If you want to use or experiment with multiple models in one application while having reduced kernel set, you can
46+
If you want to use or experiment with multiple models in one application while having a reduced kernel set, you can
4747
create one kernel selection file with the script `merge_kernel_selection_code.py`:
4848

4949
```commandline

0 commit comments

Comments
 (0)