Apply the model card standard

README.md

@@ -4,21 +4,45 @@ pipeline_tag: sentence-similarity
 library_name: executorch
 ---
 
-# Introduction
+# multi-qa-mpnet-base-dot-v1
 
-This repository hosts the [multi-qa-mpnet-base-dot-v1](https://huggingface.co/sentence-transformers/multi-qa-mpnet-base-dot-v1/tree/main) models 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.
+This repository hosts the **multi-qa-mpnet-base-dot-v1** 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.
+Upstream model: [multi-qa-mpnet-base-dot-v1](https://huggingface.co/sentence-transformers/multi-qa-mpnet-base-dot-v1/tree/main)
 
-## Compatibility
+## Variants
+
+| Path | Backend | Precision |
+| --- | --- | --- |
+| `vulkan/multi_qa_mpnet_base_dot_v1_vulkan_fp16.pte` | vulkan | fp16 |
+| `vulkan/multi_qa_mpnet_base_dot_v1_vulkan_int8.pte` | vulkan | int8 |
+| `xnnpack/multi_qa_mpnet_base_dot_v1_xnnpack_fp32.pte` | xnnpack | fp32 |
 
-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.
+## Repository structure
 
-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.
+```
+config.json                                          48 B
+tokenizer.json                                       694 kB
+tokenizer_config.json                                363 B
+vulkan/config.json                                   1.6 kB
+vulkan/multi_qa_mpnet_base_dot_v1_vulkan_fp16.pte    208 MB
+vulkan/multi_qa_mpnet_base_dot_v1_vulkan_int8.pte    127 MB
+xnnpack/config.json                                  951 B
+xnnpack/multi_qa_mpnet_base_dot_v1_xnnpack_fp32.pte  416 MB
+```
+
+## Compatibility
 
-### Repository Structure
+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.
 
-All files are located in the root directory.
+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 as the `modelSource` argument.
-- The tokenizer is provided as `tokenizer.json` in the root directory.
+To load these files in your own ExecuTorch runtime, read the
+[compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
+first.