msluszniak commited on
Commit
815d270
·
verified ·
1 Parent(s): 60fd09d

Apply the model card standard

Browse files
Files changed (1) hide show
  1. README.md +32 -8
README.md CHANGED
@@ -9,18 +9,42 @@ pipeline_tag: token-classification
9
  library_name: executorch
10
  ---
11
 
12
- # Introduction
13
 
14
- This repository hosts the **OpenAI/privacy-filter** model for the [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It includes a **quantized** version in `.pte` format, ready for use in the **ExecuTorch** runtime.
 
 
15
 
16
- 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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
 
18
  ## Compatibility
19
 
20
- If you intend to use this model 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 the runtime used behind the scenes.
 
 
21
 
22
- ## Repository Structure
 
 
23
 
24
- The repository is organized as follows:
25
- - The `.pte` file should be passed to the `modelSource` parameter.
26
- - The tokenizer files are available in the repo root: `tokenizer.json` and `tokenizer_config.json` should be passed to `tokenizerSource` and `tokenizerConfigSource` respectively.
 
9
  library_name: executorch
10
  ---
11
 
12
+ # privacy-filter-openai
13
 
14
+ This repository hosts the **privacy-filter-openai** models exported for the
15
+ [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch)
16
+ library as ExecuTorch `.pte` programs, ready to run on device.
17
 
18
+ ## Variants
19
+
20
+ | Path | Backend | Precision |
21
+ | --- | --- | --- |
22
+ | `mlx/privacy_filter_openai_mlx_int4.pte` | mlx | int4 |
23
+ | `xnnpack/privacy_filter_openai_xnnpack_8da4w.pte` | xnnpack | 8da4w |
24
+
25
+ ## Repository structure
26
+
27
+ ```
28
+ config.json 43 B
29
+ mlx/config.json 962 B
30
+ mlx/privacy_filter_openai_mlx_int4.pte 835 MB
31
+ tokenizer.json 26.6 MB
32
+ tokenizer_config.json 234 B
33
+ viterbi_calibration.json 372 B
34
+ xnnpack/config.json 972 B
35
+ xnnpack/privacy_filter_openai_xnnpack_8da4w.pte 1.2 GB
36
+ ```
37
 
38
  ## Compatibility
39
 
40
+ These files are published for the **ExecuTorch v1.4.1** runtime. ExecuTorch
41
+ gives no forward compatibility guarantee, so an older runtime may fail to load
42
+ them.
43
 
44
+ To use them in React Native ExecuTorch, pass the model constant shipped in the
45
+ library's model registry to the corresponding task pipeline. See the
46
+ [documentation](https://docs.swmansion.com/react-native-executorch/docs/fundamentals/loading-models).
47
 
48
+ To load these files in your own ExecuTorch runtime, read the
49
+ [compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
50
+ first.