Update README.md
Browse files
README.md
CHANGED
@@ -1,5 +1,29 @@
|
|
1 |
-
---
|
2 |
-
license: other
|
3 |
-
license_name: apache-license-2.0
|
4 |
-
license_link: https://github.com/google/automl/blob/master/LICENSE
|
5 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: other
|
3 |
+
license_name: apache-license-2.0
|
4 |
+
license_link: https://github.com/google/automl/blob/master/LICENSE
|
5 |
+
---
|
6 |
+
|
7 |
+
# Introduction
|
8 |
+
|
9 |
+
This repository hosts the efficientnet_v2_s 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.
|
10 |
+
|
11 |
+
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.
|
12 |
+
|
13 |
+
## Compatibility
|
14 |
+
|
15 |
+
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.
|
16 |
+
|
17 |
+
These models were exported using commit `fe20be98c` and **no forward compatibility** is guaranteed. Older versions of the runtime may not work with these files.
|
18 |
+
|
19 |
+
### Repository Structure
|
20 |
+
|
21 |
+
The repository is organized into two main directories:
|
22 |
+
|
23 |
+
- `xnnpack`
|
24 |
+
- `coreml`
|
25 |
+
|
26 |
+
Each directory contains differentely exported version of the model.
|
27 |
+
|
28 |
+
- The `.pte` file should be passed to the `modelSource` parameter.
|
29 |
+
|