Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,53 @@
+# SenseVoiceSmall-coreml
+
+[Hugging Face](https://huggingface.co/mefengl/SenseVoiceSmall-coreml) | [GitHub](https://github.com/mefengl/SenseVoiceSmall-coreml)
+
+CoreML artifact for **SenseVoiceSmall**.
+
+- Upstream model: https://huggingface.co/FunAudioLLM/SenseVoiceSmall
+- Upstream code: https://github.com/FunAudioLLM/SenseVoice
+
+## Download
+
+```bash
+uvx hf download mefengl/SenseVoiceSmall-coreml --local-dir . \
+  --include "coreml/SenseVoiceSmall.mlmodelc.zip" \
+  --include "manifest.json" \
+  --include "checksums.sha256"
+```
+
+## Verify
+
+```bash
+make verify
+```
+
+## Optional: generate CoreML `.mlpackage`
+
+This repo vendors the converter, but imports model code from upstream SenseVoice.
+
+```bash
+# clones upstream code into ./.upstream/SenseVoice automatically
+make convert DEPLOYMENT_TARGET=macOS15
+# output: ./.coreml-build/SenseVoiceSmall.mlpackage
+```
+
+## Optional: rebuild `coreml/SenseVoiceSmall.mlmodelc.zip` from a `.mlpackage`
+
+macOS + Xcode required.
+
+```bash
+make build
+make inspect
+make verify
+```
+
+## Optional: compare (numeric)
+
+Vendored script (lives in this repo), but it imports model code from upstream SenseVoice.
+
+```bash
+make compare \
+  MLPACKAGE=/path/to/SenseVoiceSmall.mlpackage
+# SENSEVOICE_REPO defaults to ./.upstream/SenseVoice (auto-cloned by `make upstream`)
+```