Apply the model card standard

README.md

@@ -38,46 +38,89 @@ pipeline_tag: text-to-speech
 library_name: executorch
 ---
 
-# Supertonic 3 TTS
+# supertonic
 
-This repository hosts the **Supertonic 3** model for the [React Native ExecuTorch](https://github.com/software-mansion/react-native-executorch) library. It performs text-to-speech synthesis supporting **30+ languages**, with a single voice style per language.
+This repository hosts the **supertonic** 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.
 
-The model is composed of four sub-models that run sequentially:
+## Variants
 
-1. **Duration predictor** — estimates speech duration from text
-2. **Text encoder** — encodes text into a style-conditioned representation
-3. **Vector estimator** — flow-matching denoiser that generates the audio latent
-4. **Vocoder** — decodes the latent into a 44.1 kHz waveform
+| Path | Component | Backend | Precision |
+| --- | --- | --- | --- |
+| `mlx/duration_predictor_mlx_fp32.pte` | duration_predictor | mlx | fp32 |
+| `mlx/text_encoder_mlx_fp32.pte` | text_encoder | mlx | fp32 |
+| `mlx/vector_estimator_mlx_fp32.pte` | vector_estimator | mlx | fp32 |
+| `mlx/vocoder_mlx_fp32.pte` | vocoder | mlx | fp32 |
+| `vulkan/duration_predictor_vulkan_fp16.pte` | duration_predictor | vulkan | fp16 |
+| `vulkan/text_encoder_vulkan_fp16.pte` | text_encoder | vulkan | fp16 |
+| `vulkan/vector_estimator_vulkan_fp16.pte` | vector_estimator | vulkan | fp16 |
+| `vulkan/vocoder_vulkan_fp16.pte` | vocoder | vulkan | fp16 |
+| `xnnpack/duration_predictor_xnnpack_fp32.pte` | duration_predictor | xnnpack | fp32 |
+| `xnnpack/text_encoder_xnnpack_fp32.pte` | text_encoder | xnnpack | fp32 |
+| `xnnpack/vector_estimator_xnnpack_fp32.pte` | vector_estimator | xnnpack | fp32 |
+| `xnnpack/vocoder_xnnpack_fp32.pte` | vocoder | xnnpack | fp32 |
 
-## Compatibility
-
-These models were exported using **v1.3.1** of ExecuTorch and no forward compatibility is guaranteed. Older versions of the runtime may not work with these files.
-
-The models are intended to be used within the React Native ExecuTorch package. If you want to use them outside the package, make sure your runtime is compatible with the ExecuTorch version used to export the `.pte` files and follow the example scripts to run the models.
+## Unshipped backends
 
-## Backends
+A backend directory carrying a `NOTES.md` and no `.pte` was exported and
+not published. Its note records what went wrong.
 
-| Backend | Description | RTF (Apple Silicon) |
-|---------|-------------|---------------------|
-| `xnnpack` | CPU-optimized via XNNPACK delegate | ~0.07 (14× faster than real-time) |
-| `mlx` | Apple Silicon GPU via MLX delegate | ~0.026 (38× faster than real-time) |
+- `coreml` ([why](https://huggingface.co/software-mansion/react-native-executorch-supertonic/blob/main/coreml/NOTES.md))
 
-## Repository Structure
+## Repository structure
 
 ```
-.
-├── config.json              # Backend-agnostic model manifest
-├── unicode_indexer.json     # Character-to-id mapping for text preprocessing
-├── voices/                  # Pre-computed speaker embeddings
-│   ├── M1.json
-│   ├── M2.json
-│   ├── F1.json
-│   └── ...
-├── xnnpack/                 # XNNPACK-exported .pte files
-└── mlx/                     # MLX-exported .pte files
+config.json                                  32 B
+coreml/NOTES.md                              879 B
+mlx/config.json                              6.7 kB
+mlx/duration_predictor_mlx_fp32.pte          3.4 MB
+mlx/text_encoder_mlx_fp32.pte                34.4 MB
+mlx/vector_estimator_mlx_fp32.pte            244 MB
+mlx/vocoder_mlx_fp32.pte                     96.7 MB
+unicode_indexer.json                         271 kB
+voice_styles/F1.json                         285 kB
+voice_styles/F2.json                         286 kB
+voice_styles/F3.json                         284 kB
+voice_styles/F4.json                         285 kB
+voice_styles/F5.json                         285 kB
+voice_styles/M1.json                         285 kB
+voice_styles/M2.json                         285 kB
+voice_styles/M3.json                         283 kB
+voice_styles/M4.json                         285 kB
+voice_styles/M5.json                         285 kB
+voices/F1.bin                                50.5 kB
+voices/F2.bin                                50.5 kB
+voices/F3.bin                                50.5 kB
+voices/F4.bin                                50.5 kB
+voices/F5.bin                                50.5 kB
+voices/M1.bin                                50.5 kB
+voices/M2.bin                                50.5 kB
+voices/M3.bin                                50.5 kB
+voices/M4.bin                                50.5 kB
+voices/M5.bin                                50.5 kB
+vulkan/config.json                           4.1 kB
+vulkan/duration_predictor_vulkan_fp16.pte    1.7 MB
+vulkan/text_encoder_vulkan_fp16.pte          17.3 MB
+vulkan/vector_estimator_vulkan_fp16.pte      122 MB
+vulkan/vocoder_vulkan_fp16.pte               48.4 MB
+xnnpack/config.json                          6.7 kB
+xnnpack/duration_predictor_xnnpack_fp32.pte  3.4 MB
+xnnpack/text_encoder_xnnpack_fp32.pte        34.5 MB
+xnnpack/vector_estimator_xnnpack_fp32.pte    245 MB
+xnnpack/vocoder_xnnpack_fp32.pte             96.7 MB
 ```
 
-Each `.pte` file exposes two methods:
+## Compatibility
+
+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).
 
-- `forward` — the sub-model inference
-- `get_dynamic_dims_forward` — returns per-input `[rank, 3]` shape constraints (`[min, max, step]`) for runtime input validation
+To load these files in your own ExecuTorch runtime, read the
+[compatibility note](https://github.com/pytorch/executorch/blob/main/runtime/COMPATIBILITY.md)
+first.