chmjkb commited on
Commit
e2447a5
·
1 Parent(s): ed86ad9

docs: add README

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