Create README.md

README.md

@@ -0,0 +1,27 @@
+---
+license: apache-2.0
+language:
+- he
+base_model:
+- openai/whisper-large-v3-turbo
+---
+
+This is ivrit.ai's faster-whisper model, based on the ivrit-ai/yi-whisper-large-v3-turbo Whisper model.
+
+# Prerequisites
+
+pip3 install faster_whisper
+
+# Usage
+
+```
+import faster_whisper
+model = faster_whisper.WhisperModel('ivrit-ai/yi-whisper-large-v3-turbo-ct2')
+
+segs, _ = model.transcribe('media-file', language='he')
+
+texts = [s.text for s in segs]
+
+transcribed_text = ' '.join(texts)
+print(f'Transcribed text: {transcribed_text}')
+```