Apply the model card standard

README.md

@@ -13,12 +13,77 @@ tags:
 library_name: executorch
 ---
 
-# Introduction
+# lfm-2.5
 
-This repository hosts the **LFM2.5** 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.
+This repository hosts the **lfm-2.5** models exported for the
+[React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch)
+library as ExecuTorch `.pte` programs, ready to run on device.
 
-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.
+## Variants
+
+| Path | Backend | Precision |
+| --- | --- | --- |
+| `1_2b/mlx/lfm_2_5_1_2b_mlx_int4.pte` | mlx | 4w |
+| `1_2b/xnnpack/lfm_2_5_1_2b_xnnpack_8da4w.pte` | xnnpack | 8da4w |
+| `1_2b/xnnpack/lfm_2_5_1_2b_xnnpack_fp16.pte` | xnnpack | fp16 |
+| `350m/mlx/lfm_2_5_350m_mlx_int4.pte` | mlx | 4w |
+| `350m/xnnpack/lfm_2_5_350m_xnnpack_8da4w.pte` | xnnpack | 8da4w |
+| `350m/xnnpack/lfm_2_5_350m_xnnpack_fp16.pte` | xnnpack | fp16 |
+| `vl_1_6b/mlx/lfm_2_5_vl_1_6b_mlx_int4.pte` | mlx | int4 |
+| `vl_1_6b/mlx/lfm_2_5_vl_1_6b_mlx_int8.pte` | mlx | int8 |
+| `vl_1_6b/vulkan/lfm_2_5_vl_1_6b_vulkan_8da4w.pte` | vulkan | 8da4w |
+| `vl_1_6b/xnnpack/lfm_2_5_vl_1_6b_xnnpack_8da4w.pte` | xnnpack | 8da4w |
+| `vl_450m/mlx/lfm_2_5_vl_450m_mlx_int4.pte` | mlx | int4 |
+| `vl_450m/vulkan/lfm_2_5_vl_450m_vulkan_8da4w.pte` | vulkan | 8da4w |
+| `vl_450m/xnnpack/lfm_2_5_vl_450m_xnnpack_8da4w.pte` | xnnpack | 8da4w |
+
+## Repository structure
+
+```
+1_2b/mlx/config.json                               1.2 kB
+1_2b/mlx/lfm_2_5_1_2b_mlx_int4.pte                 849 MB
+1_2b/tokenizer.json                                4.5 MB
+1_2b/tokenizer_config.json                         92.4 kB
+1_2b/xnnpack/config.json                           2.1 kB
+1_2b/xnnpack/lfm_2_5_1_2b_xnnpack_8da4w.pte        759 MB
+1_2b/xnnpack/lfm_2_5_1_2b_xnnpack_fp16.pte         2.4 GB
+350m/mlx/config.json                               1.2 kB
+350m/mlx/lfm_2_5_350m_mlx_int4.pte                 308 MB
+350m/tokenizer.json                                4.5 MB
+350m/tokenizer_config.json                         2.9 kB
+350m/xnnpack/config.json                           2.1 kB
+350m/xnnpack/lfm_2_5_350m_xnnpack_8da4w.pte        265 MB
+350m/xnnpack/lfm_2_5_350m_xnnpack_fp16.pte         806 MB
+config.json                                        29 B
+vl_1_6b/mlx/config.json                            1.7 kB
+vl_1_6b/mlx/lfm_2_5_vl_1_6b_mlx_int4.pte           1.4 GB
+vl_1_6b/mlx/lfm_2_5_vl_1_6b_mlx_int8.pte           2.0 GB
+vl_1_6b/tokenizer.json                             4.5 MB
+vl_1_6b/tokenizer_config.json                      3.2 kB
+vl_1_6b/vulkan/config.json                         2.1 kB
+vl_1_6b/vulkan/lfm_2_5_vl_1_6b_vulkan_8da4w.pte    2.4 GB
+vl_1_6b/xnnpack/config.json                        2.1 kB
+vl_1_6b/xnnpack/lfm_2_5_vl_1_6b_xnnpack_8da4w.pte  2.3 GB
+vl_450m/mlx/config.json                            1.0 kB
+vl_450m/mlx/lfm_2_5_vl_450m_mlx_int4.pte           376 MB
+vl_450m/tokenizer.json                             4.5 MB
+vl_450m/tokenizer_config.json                      3.2 kB
+vl_450m/vulkan/config.json                         2.1 kB
+vl_450m/vulkan/lfm_2_5_vl_450m_vulkan_8da4w.pte    626 MB
+vl_450m/xnnpack/config.json                        2.1 kB
+vl_450m/xnnpack/lfm_2_5_vl_450m_xnnpack_8da4w.pte  619 MB
+```
 
 ## Compatibility
 
-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.
+These files are published for the **ExecuTorch v1.4.1** runtime. ExecuTorch
+gives no forward compatibility guarantee, so an older runtime may fail to load
+them.
+
+To use them in React Native ExecuTorch, pass the model constant shipped in the
+library's model registry to the corresponding task pipeline. See the
+[documentation](https://docs.swmansion.com/react-native-executorch/docs/fundamentals/loading-models).
+
+To load these files in your own ExecuTorch runtime, read the
+[compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
+first.