bhanc commited on
Commit
3dc035e
·
verified ·
1 Parent(s): 7104074

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -0
README.md CHANGED
@@ -1,3 +1,25 @@
1
  ---
2
  license: apache-2.0
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
  ---
4
+ # Introduction
5
+
6
+ This repository hosts the [BlazeFace](https://github.com/hollance/BlazeFace-PyTorch) models for the [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library.
7
+ It includes the model exported for xnnpack in `.pte` format, ready for use in the **ExecuTorch** runtime.
8
+
9
+ If you'd like to run these models in your own ExecuTorch runtime, refer to the
10
+ [official documentation](https://pytorch.org/executorch/stable/index.html) for
11
+ setup instructions.
12
+
13
+ ## Compatibility
14
+
15
+ If you intend to use this models outside of React Native ExecuTorch, make sure
16
+ your runtime is compatible with the **ExecuTorch** version used to export the
17
+ `.pte` files. For more details, see the compatibility note in the [ExecuTorch
18
+ GitHub
19
+ repository](https://github.com/pytorch/executorch/blob/11d1742fdeddcf05bc30a6cfac321d2a2e3b6768/runtime/COMPATIBILITY.md?plain=1#L4).
20
+ If you work with React Native ExecuTorch, the constants shipped with the library
21
+ will guarantee compatibility with runtime used behind the scenes.
22
+
23
+ These models were exported using **ExecuTorch** version 1.2.0 and **no forward
24
+ compatibility** is guaranteed. Older versions of the runtime may not work with
25
+ these files.