nklockiewicz commited on
Commit
2d5a0b1
·
verified ·
1 Parent(s): 983d75a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -0
README.md CHANGED
@@ -11,3 +11,19 @@ tags:
11
  - lfm2.5-vl
12
  - lfm2.5
13
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  - lfm2.5-vl
12
  - lfm2.5
13
  ---
14
+
15
+ # Introduction
16
+
17
+ This repository hosts the **LFM2.5-VL-1.6B** vision-language 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.
18
+
19
+ 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.
20
+
21
+ ## Compatibility
22
+
23
+ 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.
24
+
25
+ ## Repository Structure
26
+
27
+ The repository is organized as follows:
28
+ - The `.pte` file should be passed to the `modelSource` parameter.
29
+ - The tokenizer files are available in the repo root: `tokenizer.json` and `tokenizer_config.json` should be passed to `tokenizerSource` and `tokenizerConfigSource` respectively.