Apply the model card standard

README.md

@@ -4,39 +4,54 @@ pipeline_tag: image-feature-extraction
 library_name: executorch
 ---
 
-# Introduction
-
-This repository hosts the image encoder of
-[clip-vit-base-patch32](https://huggingface.co/openai/clip-vit-base-patch32)
-model for the [React Native
-ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It
-includes the model exported for xnnpack in `.pte` format, ready for use in the
-**ExecuTorch** runtime.
-
-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.
+# clip-vit-base-patch32
+
+This repository hosts the **clip-vit-base-patch32** 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.
+
+Upstream model: [clip-vit-base-patch32](https://huggingface.co/openai/clip-vit-base-patch32)
+
+## Variants
+
+| Path | Component | Backend | Precision |
+| --- | --- | --- | --- |
+| `coreml/clip_vit_base_patch32_image_coreml_fp16.pte` | image | coreml | fp16 |
+| `coreml/clip_vit_base_patch32_text_coreml_fp16.pte` | text | coreml | fp16 |
+| `mlx/clip_vit_base_patch32_image_mlx_int8.pte` | - | mlx | int8 |
+| `vulkan/clip_vit_base_patch32_image_vulkan_fp16.pte` | image | vulkan | fp16 |
+| `vulkan/clip_vit_base_patch32_text_vulkan_fp16.pte` | text | vulkan | fp16 |
+| `xnnpack/clip_vit_base_patch32_image_xnnpack_fp32.pte` | image | xnnpack | fp32 |
+| `xnnpack/clip_vit_base_patch32_text_xnnpack_fp32.pte` | text | xnnpack | fp32 |
+
+## Repository structure
+
+```
+config.json                                           43 B
+coreml/clip_vit_base_patch32_image_coreml_fp16.pte    168 MB
+coreml/clip_vit_base_patch32_text_coreml_fp16.pte     122 MB
+coreml/config.json                                    1.7 kB
+mlx/clip_vit_base_patch32_image_mlx_int8.pte          93.7 MB
+mlx/config.json                                       840 B
+tokenizer.json                                        2.1 MB
+vulkan/clip_vit_base_patch32_image_vulkan_fp16.pte    168 MB
+vulkan/clip_vit_base_patch32_text_vulkan_fp16.pte     121 MB
+vulkan/config.json                                    1.7 kB
+xnnpack/clip_vit_base_patch32_image_xnnpack_fp32.pte  335 MB
+xnnpack/clip_vit_base_patch32_text_xnnpack_fp32.pte   242 MB
+xnnpack/config.json                                   1.6 kB
+```
 
 ## 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.
-
-These models were exported using **ExecuTorch** version 1.1.0 and **no forward
-compatibility** is guaranteed. Older versions of the runtime may not work with
-these files.
-
-### Repository Structure
-
-The repository is organized into directories:
-
-- `xnnpack`
+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.
 
-Each directory contains models exported for the respective backend.
+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.
+To load these files in your own ExecuTorch runtime, read the
+[compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
+first.