Apply the model card standard

README.md

@@ -3,25 +3,39 @@ license: apache-2.0
 pipeline_tag: keypoint-detection
 library_name: executorch
 ---
-# Introduction
 
-This repository hosts the [BlazeFace](https://github.com/hollance/BlazeFace-PyTorch) 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.
+# blazeface
 
-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.
+This repository hosts the **blazeface** 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: [BlazeFace](https://github.com/hollance/BlazeFace-PyTorch)
+
+## Variants
+
+| Path | Backend | Precision |
+| --- | --- | --- |
+| `xnnpack/blazeface_xnnpack_fp32.pte` | xnnpack | fp32 |
+
+## Repository structure
+
+```
+config.json                         31 B
+xnnpack/blazeface_xnnpack_fp32.pte  635 kB
+xnnpack/config.json                 1.2 kB
+```
 
 ## Compatibility
 
-If you intend to use this models 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 shipped with the library
-will guarantee compatibility with runtime used behind the scenes.
-
-These models were exported using **ExecuTorch** version 1.2.0 and **no forward
-compatibility** is guaranteed. Older versions of the runtime may not work with
-these files.
+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.