bhanc's picture
Update README
01d8bb2
|
Raw
History Blame Contribute Delete
1.5 kB
---
license: other
---
# Introduction
This repository hosts the [style
transfer](https://github.com/pytorch/examples/tree/main/fast_neural_style) candy
models for the [React Native
ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It
includes model exported for xnnpack, as well as coreml in `.pte` format, ready
for use in the **ExecuTorch** runtime.
If you'd like to run these models in your own ExecuTorch runtime, refer to the
[official documentation](https://pytorch.org/executorch/stable/index.html) for
setup instructions.
## Compatibility
If you intend to use this models outside of React Native ExecuTorch, make sure
your runtime is compatible with the **ExecuTorch** version used to export the
`.pte` files. For more details, see the compatibility note in the [ExecuTorch
GitHub
repository](https://github.com/pytorch/executorch/blob/11d1742fdeddcf05bc30a6cfac321d2a2e3b6768/runtime/COMPATIBILITY.md?plain=1#L4).
If you work with React Native ExecuTorch, the constants from the library will
guarantee compatibility with runtime used behind the scenes.
These models were exported using **ExecuTorch** version 1.1.0 and no forward
compatibility is guaranteed. Older versions of the runtime may not work with
these files.
### Repository Structure
The repository is organized into two main directories:
- `xnnpack`
- `coreml`
Each directory contains differentely exported version of the model.
- The `.pte` file should be passed to the `modelSource` parameter.