xref: /aosp_15_r20/external/executorch/extension/llm/modules/README.md (revision 523fa7a60841cd1ecfb9cc4201f1ca8b03ed023a)
1*523fa7a6SAndroid Build Coastguard Worker## Export-friendly Modules
2*523fa7a6SAndroid Build Coastguard Worker
3*523fa7a6SAndroid Build Coastguard WorkerModules in this directory:
4*523fa7a6SAndroid Build Coastguard Worker* Extend `torch.nn.Module`.
5*523fa7a6SAndroid Build Coastguard Worker* Are guaranteed to work out of the box with `torch.export.export()`.
6*523fa7a6SAndroid Build Coastguard Worker* Should work out of the box with `torch.aot_compile()`.
7*523fa7a6SAndroid Build Coastguard Worker* Should be able to workt with ExecuTorch.
8*523fa7a6SAndroid Build Coastguard Worker
9*523fa7a6SAndroid Build Coastguard WorkerAll modules should be covered by unit tests to make sure they are:
10*523fa7a6SAndroid Build Coastguard Worker1. Give the output as the reference eager model in PyTorch or TorrchTune
11*523fa7a6SAndroid Build Coastguard Worker2. Export-friendly
12*523fa7a6SAndroid Build Coastguard Worker
13*523fa7a6SAndroid Build Coastguard WorkerAdditionally, we aim to make these modules:
14*523fa7a6SAndroid Build Coastguard Worker3. AOTI-friendly
15*523fa7a6SAndroid Build Coastguard Worker4. ExecuTorch-friendly
16*523fa7a6SAndroid Build Coastguard Worker
17*523fa7a6SAndroid Build Coastguard WorkerThese modules are subject to change (may upstream to TorchTune) so proceed with caution.
18