msluszniak commited on
Commit
8a66218
·
verified ·
1 Parent(s): d6f7580

Apply the model card standard

Browse files
Files changed (1) hide show
  1. README.md +34 -5
README.md CHANGED
@@ -11,15 +11,44 @@ base_model:
11
  library_name: executorch
12
  ---
13
 
14
- # Introduction
15
 
16
- This repository hosts the **Gemma4** model family 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.
 
 
17
 
18
- 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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
 
20
  ## Compatibility
21
 
22
- 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. If you work with React Native ExecuTorch, the constants from the library will guarantee compatibility with runtime used behind the scenes.
 
 
23
 
24
- These models were exported using v1.3.0 version of ExecuTorch and no forward compatibility is guaranteed. Older versions of the runtime may not work with these files.
 
 
25
 
 
 
 
 
11
  library_name: executorch
12
  ---
13
 
14
+ # gemma-4
15
 
16
+ This repository hosts the **gemma-4** models exported for the
17
+ [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch)
18
+ library as ExecuTorch `.pte` programs, ready to run on device.
19
 
20
+ ## Variants
21
+
22
+ | Path | Backend | Precision |
23
+ | --- | --- | --- |
24
+ | `e2b/mlx/gemma4_e2b_mlx_int4.pte` | mlx | int4 |
25
+ | `e2b/vulkan/gemma_4_e2b_vulkan_8da4w.pte` | vulkan | 8da4w |
26
+ | `e2b/xnnpack/gemma_4_e2b_xnnpack_8da4w.pte` | xnnpack | 8da4w |
27
+
28
+ ## Repository structure
29
+
30
+ ```
31
+ config.json 28 B
32
+ e2b/mlx/config.json 1.2 kB
33
+ e2b/mlx/gemma4_e2b_mlx_int4.pte 2.7 GB
34
+ e2b/tokenizer.json 30.7 MB
35
+ e2b/tokenizer_config.json 21.8 kB
36
+ e2b/vulkan/config.json 1.3 kB
37
+ e2b/vulkan/gemma_4_e2b_vulkan_8da4w.pte 2.4 GB
38
+ e2b/xnnpack/config.json 1.3 kB
39
+ e2b/xnnpack/gemma_4_e2b_xnnpack_8da4w.pte 2.5 GB
40
+ ```
41
 
42
  ## Compatibility
43
 
44
+ These files are published for the **ExecuTorch v1.4.1** runtime. ExecuTorch
45
+ gives no forward compatibility guarantee, so an older runtime may fail to load
46
+ them.
47
 
48
+ To use them in React Native ExecuTorch, pass the model constant shipped in the
49
+ library's model registry to the corresponding task pipeline. See the
50
+ [documentation](https://docs.swmansion.com/react-native-executorch/docs/fundamentals/loading-models).
51
 
52
+ To load these files in your own ExecuTorch runtime, read the
53
+ [compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
54
+ first.