Apply the model card standard

README.md

@@ -4,14 +4,52 @@ pipeline_tag: automatic-speech-recognition
 library_name: executorch
 ---
 
-# Introduction
+# whisper-tiny
 
-This repository hosts the [whisper-tiny](https://huggingface.co/openai/whisper-tiny) model for the [React Native ExecuTorch](https://www.npmjs.com/package/react-native-executorch) library. It includes the model exported for XNNPACK, CoreML and MLX backends in `.pte` format, ready for use in the **ExecuTorch** runtime.
+This repository hosts the **whisper-tiny** 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: [whisper-tiny](https://huggingface.co/openai/whisper-tiny)
+
+## Variants
+
+| Path | Backend | Precision |
+| --- | --- | --- |
+| `coreml/whisper_tiny_coreml_fp16.pte` | coreml | fp16 |
+| `mlx/whisper_tiny_mlx_bf16.pte` | mlx | bf16 |
+| `mlx/whisper_tiny_mlx_int8.pte` | mlx | int8 |
+| `vulkan/whisper_tiny_vulkan_int8.pte` | vulkan | int8 |
+| `vulkan/whisper_tiny_vulkan_fp16.pte` | vulkan | fp16 |
+| `xnnpack/whisper_tiny_xnnpack_fp32.pte` | xnnpack | fp32 |
+
+## Repository structure
+
+```
+config.json                            34 B
+coreml/config.json                     1.5 kB
+coreml/whisper_tiny_coreml_fp16.pte    72.9 MB
+mlx/config.json                        2.6 kB
+mlx/whisper_tiny_mlx_bf16.pte          72.6 MB
+mlx/whisper_tiny_mlx_int8.pte          57.1 MB
+tokenizer.json                         2.4 MB
+vulkan/config.json                     2.6 kB
+vulkan/whisper_tiny_vulkan_fp16.pte    204 MB
+vulkan/whisper_tiny_vulkan_int8.pte    124 MB
+xnnpack/config.json                    1.4 kB
+xnnpack/whisper_tiny_xnnpack_fp32.pte  222 MB
+```
 
 ## 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 from the library will guarantee compatibility with 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).
 
-These models were exported using v1.2.0 version of ExecuTorch and **no forward compatibility** is guaranteed. Older versions of the runtime may not work with these files.
+To load these files in your own ExecuTorch runtime, read the
+[compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
+first.