Merge pull request #105 from kadirnar/add_mlx_library

🍎 Add Mlx library

.pre-commit-config.yaml

@@ -55,15 +55,6 @@ repos:
       - id: flake8
         name: Flake8 linting
 
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
-    hooks:
-      - id: codespell
-        args:
-          - --ignore-words-list=crate,nd,strack,dota,ane,segway,fo,gool,winn
-          # skip inline comments
-          - --skip="*.py:.*#.*,*ipynb"
-
   - repo: https://github.com/PyCQA/docformatter
     rev: v1.7.5
     hooks:

README.md

@@ -17,7 +17,7 @@
 ## 🛠️ Installation
 
 ```bash
-pip install git+https://github.com/huggingface/transformers
+pip install whisperplus git+https://github.com/huggingface/transformers
 pip install flash-attn --no-build-isolation
 ```
 
@@ -74,6 +74,21 @@ transcript = pipeline(
 print(transcript)
 ```
 
+### Apple MLX
+
+```python
+from whisperplus.pipelines import mlx_whisper
+from whisperplus import download_youtube_to_mp3
+
+url = "https://www.youtube.com/watch?v=1__CAdTJ5JU"
+audio_path = download_youtube_to_mp3(url)
+
+text = mlx_whisper.transcribe(
+    audio_path, path_or_hf_repo="mlx-community/whisper-large-v3-mlx"
+)["text"]
+print(text)
+```
+
 ### 📰 Summarization
 
 ```python

whisperplus/pipelines/mlx_whisper/__init__.py

@@ -0,0 +1,5 @@
+# Copyright © 2023-2024 Apple Inc.
+
+from . import audio, decoding, load_models
+from .transcribxe import transcribe
+from .version import __version__