Apply the model card standard

README.md

@@ -6,26 +6,43 @@ tags:
 library_name: executorch
 ---
 
-# Introduction
+# phi-4-mini
 
-This repository hosts the **Phi 4 Mini** models for the [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It includes **unquantized** and **quantized** versions of the Phi model in `.pte` format, ready for use in the **ExecuTorch** runtime.
+This repository hosts the **phi-4-mini** 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
 
-## 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 runtime used behind the scenes.
+| Path | Backend | Precision |
+| --- | --- | --- |
+| `mlx/phi_4_mini_mlx_int4.pte` | mlx | 4w |
+| `xnnpack/phi_4_mini_xnnpack_bf16.pte` | xnnpack | bf16 |
+| `xnnpack/phi_4_mini_xnnpack_8da4w.pte` | xnnpack | 8da4w |
 
-These models were exported using `v0.6.0` version and **no forward compatibility** is guaranteed. Older versions of the runtime may not work with these files.
+## Repository structure
 
-### Repository Structure
+```
+config.json                           32 B
+mlx/config.json                       1.3 kB
+mlx/phi_4_mini_mlx_int4.pte           3.0 GB
+tokenizer.json                        14.8 MB
+tokenizer_config.json                 2.9 kB
+xnnpack/config.json                   2.3 kB
+xnnpack/phi_4_mini_xnnpack_8da4w.pte  2.6 GB
+xnnpack/phi_4_mini_xnnpack_bf16.pte   7.1 GB
+```
 
-The repository is organized into two main directory:
+## Compatibility
 
-- `original`
-- `quantized`
+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.
 
-The directory contains original version of model.
+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).
 
-- The `.pte` file should be passed to the `modelSource` parameter.
-- The tokenizer for the models is available within the repo root, under `tokenizer.json` and `tokenizer_config.json`
+To load these files in your own ExecuTorch runtime, read the
+[compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
+first.