bhanc commited on
Commit
4333eb5
·
1 Parent(s): ab3cdd1

Update README

Browse files
Files changed (1) hide show
  1. README.md +27 -8
README.md CHANGED
@@ -5,19 +5,38 @@ license_name: bsd-3-clause
5
  ---
6
  # Introduction
7
 
8
- This repository hosts the [SSDLite320 MobilenetV3 Large](https://pytorch.org/vision/main/models/generated/torchvision.models.detection.ssdlite320_mobilenet_v3_large.html#ssdlite320-mobilenet-v3-large) model for the [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It includes the model exported for xnnpack in `.pte` format, ready for use in the **ExecuTorch** runtime.
9
-
10
- 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.
11
-
12
- ⚠️ **Warning:** This model does not contain the NMS layers! If you intend to use this model outside of React Native ExecuTorch or useObjectDetection hook, you have to implement the postprocessing. For more information, refer to [this code](https://github.com/software-mansion/react-native-executorch/blob/240af5bdc1981fcc42630aa59becb61ae7ae6da2/ios/RnExecutorch/models/object_detection/SSDLiteLargeModel.mm#L2)
 
13
 
 
 
 
14
 
15
  ## Compatibility
16
 
17
- 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 shipped with the library will guarantee compatibility with runtime used behind the scenes.
 
 
 
 
 
 
18
 
19
- These models were exported using commit `fe20be98c` and **no forward compatibility** is guaranteed. Older versions of the runtime may not work with these files.
 
 
20
 
21
  ### Repository Structure
22
 
23
- - The `ssdlite320-mobilenet-v3-large.pte` file url from the root of this repository should be passed to the `modelSource` parameter.
 
 
 
 
 
 
 
 
5
  ---
6
  # Introduction
7
 
8
+ This repository hosts the [SSDLite320 MobilenetV3
9
+ Large](https://pytorch.org/vision/main/models/generated/torchvision.models.detection.ssdlite320_mobilenet_v3_large.html#ssdlite320-mobilenet-v3-large)
10
+ model for the [React Native
11
+ ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It
12
+ includes the model exported for xnnpack in `.pte` format, ready for use in the
13
+ **ExecuTorch** runtime.
14
 
15
+ If you'd like to run these models in your own ExecuTorch runtime, refer to the
16
+ [official documentation](https://pytorch.org/executorch/stable/index.html) for
17
+ setup instructions.
18
 
19
  ## Compatibility
20
 
21
+ If you intend to use this models outside of React Native ExecuTorch, make sure
22
+ your runtime is compatible with the **ExecuTorch** version used to export the
23
+ `.pte` files. For more details, see the compatibility note in the [ExecuTorch
24
+ GitHub
25
+ repository](https://github.com/pytorch/executorch/blob/11d1742fdeddcf05bc30a6cfac321d2a2e3b6768/runtime/COMPATIBILITY.md?plain=1#L4).
26
+ If you work with React Native ExecuTorch, the constants shipped with the library
27
+ will guarantee compatibility with runtime used behind the scenes.
28
 
29
+ These models were exported using **ExecuTorch** version 1.1.0 and **no forward
30
+ compatibility** is guaranteed. Older versions of the runtime may not work with
31
+ these files.
32
 
33
  ### Repository Structure
34
 
35
+ The repository is organized into two main directories:
36
+
37
+ - `xnnpack`
38
+ - `coreml`
39
+
40
+ Each directory contains models exported for the respective backend.
41
+
42
+ - The `.pte` file should be passed to the `modelSource` parameter.