Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,62 @@
+---
+license: mit
+language:
+  - en
+  - multilingual
+tags:
+  - whisper
+  - speech-to-text
+  - mlx
+  - quantized
+  - q8
+  - apple-silicon
+library_name: transformers
+pipeline_tag: automatic-speech-recognition
+base_model: openai/whisper-small
+---
+
+# Whisper Small - MLX Q8 Quantized
+
+8-bit quantized version of OpenAI's Whisper Small, optimized for Apple Silicon with MLX.
+
+## Model Details
+
+| Property | Value |
+|----------|-------|
+| Original Model | [openai/whisper-small](https://huggingface.co/openai/whisper-small) |
+| Parameters | ~244M |
+| Quantization | INT8 (Q8) |
+| Size | ~300MB |
+
+## Other Whisper Models
+
+| Model | Size | Link |
+|-------|------|------|
+| **small** (this) | ~300MB | - |
+| medium | ~800MB | [LibraxisAI/whisper-medium-mlx-q8](https://huggingface.co/LibraxisAI/whisper-medium-mlx-q8) |
+| large-v3 | ~1.6GB | [LibraxisAI/whisper-large-v3-mlx-q8](https://huggingface.co/LibraxisAI/whisper-large-v3-mlx-q8) |
+| large-v3-turbo | ~900MB | [LibraxisAI/whisper-large-v3-turbo-mlx-q8](https://huggingface.co/LibraxisAI/whisper-large-v3-turbo-mlx-q8) |
+
+## Usage
+
+```python
+import mlx_whisper
+
+result = mlx_whisper.transcribe(
+    "audio.wav",
+    path_or_hf_repo="LibraxisAI/whisper-small-mlx-q8"
+)
+print(result["text"])
+```
+
+## Hardware Requirements
+
+- Apple Silicon Mac (M1/M2/M3/M4)
+- Minimum 8GB RAM
+
+## License
+
+MIT - inherited from OpenAI Whisper.
+
+---
+*Converted by [LibraxisAI](https://huggingface.co/LibraxisAI) using mlx-whisper*