parakeet-mlx 0.1.0__tar.gz

parakeet_mlx-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

parakeet_mlx-0.1.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: parakeet-mlx
+Version: 0.1.0
+Summary: An implementation of the Nvidia's Parakeet models for Apple Silicon using MLX.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: audiofile>=1.5.1
+Requires-Dist: audresample>=1.3.3
+Requires-Dist: dacite>=1.9.2
+Requires-Dist: huggingface-hub>=0.30.2
+Requires-Dist: librosa>=0.11.0
+Requires-Dist: mlx>=0.22.1
+Requires-Dist: numpy>=2.2.5
+Requires-Dist: typer>=0.15.3
+Dynamic: license-file
+
+# Parakeet MLX
+
+An implementation of the Parakeet models - Nvidia's ASR(Automatic Speech Recognition) models - for Apple Silicon using MLX.
+
+> Currently only for Parakeet TDT models. Support for additional Parakeet model variants is planned.
+
+## Installation
+
+Using [uv](https://docs.astral.sh/uv/) - recommended way:
+
+```bash
+uv add git+https://github.com/senstella/parakeet-mlx
+```
+
+Or, for the CLI:
+
+```bash
+uv tool install git+https://github.com/senstella/parakeet-mlx
+```
+
+Using pip:
+
+```bash
+pip install git+https://github.com/senstella/parakeet-mlx
+```
+
+## CLI Quick Start
+
+```bash
+parakeet-mlx <audio_files> [OPTIONS]
+```
+
+## Arguments
+
+- `audio_files`: One or more audio files to transcribe (WAV, MP3, etc.)
+
+## Options
+
+- `--model` (default: `senstella/parakeet-tdt-0.6b-v2-mlx`)
+  - Hugging Face repository of the model to use
+
+- `--output-dir` (default: current directory)
+  - Directory to save transcription outputs
+
+- `--output-format` (default: srt)
+  - Output format (txt/srt/vtt/json/all)
+
+- `--output-template` (default: `{filename}`)
+  - Template for output filenames, `{filename}`, `{index}`, `{date}` is supported.
+
+- `--highlight-words` (default: False)
+  - Enable word-level timestamps in SRT/VTT outputs
+
+- `--verbose` / `-v` (default: False)
+  - Print detailed progress information
+
+## Examples
+
+```bash
+# Basic transcription
+parakeet-mlx audio.mp3
+
+# Multiple files with word-level timestamps of VTT subtitle
+parakeet-mlx *.mp3 --output-format vtt --highlight-words
+
+# Generate all output formats
+parakeet-mlx audio.mp3 --output-format all
+```
+
+
+## Python API Quick Start
+
+Transcribe a file:
+
+```py
+from parakeet_mlx import from_pretrained
+
+model = from_pretrained("senstella/parakeet-tdt-0.6b-v2-mlx")
+
+result = model.transcribe("audio_file.wav")
+
+print(result.text)
+```
+
+Check timestamps:
+
+```py
+from parakeet_mlx import from_pretrained
+
+model = from_pretrained("senstella/parakeet-tdt-0.6b-v2-mlx")
+
+result = model.transcribe("audio_file.wav")
+
+print(result.sentences)
+# [AlignedSentence(text="Hello World.", start=1.01, end=2.04, duration=1.03, tokens=[...])]
+```
+
+## Timestamp Result
+
+- `AlignedResult`: Top-level result containing the full text and sentences
+  - `text`: Full transcribed text
+  - `sentences`: List of `AlignedSentence`
+- `AlignedSentence`: Sentence-level alignments with start/end times
+  - `text`: Sentence text
+  - `start`: Start time in seconds
+  - `end`: End time in seconds
+  - `duration`: Between `start` and `end`.
+  - `tokens`: List of `AlignedToken`
+- `AlignedToken`: Word/token-level alignments with precise timestamps
+  - `text`: Token text
+  - `start`: Start time in seconds
+  - `end`: End time in seconds
+  - `duration`: Between `start` and `end`.
+
+## Low-Level API
+
+To transcribe log-mel spectrum directly, you can do the following:
+
+```python
+import mlx.core as mx
+from parakeet_mlx.audio import get_logmel, load_audio
+
+# Load and preprocess audio manually
+audio = load_audio("audio.wav", model.preprocessor_config.sample_rate)
+mel = get_logmel(audio, model.preprocessor_config)
+
+# Generate transcription with alignments
+# Accepts both [batch, sequence, feat] and [sequence, feat]
+# `alignments` is list of AlignedResult. (no matter you fed batch dimension or not!)
+alignments = model.generate(mel)
+```
+
+## Todo
+
+- [X] Add CLI for better usability
+- [ ] Streaming input (Although RTF is MUCH higher than 1 currently - it should be much sufficient to stream with current state)
+- [ ] Compiling for RNNT decoder
+- [ ] Add support for other Parakeet varients
+- [ ] Remove librosa dependency
+
+
+## Acknowledgments
+
+- Thanks to [Nvidia](https://www.nvidia.com/) for training this awesome models and writing cool papers and providing nice implementation.
+- Thanks to [MLX](https://github.com/ml-explore/mlx) project for providing the framework that made this implementation possible.
+- Thanks to [audiofile](https://github.com/audeering/audiofile) and [audresample](https://github.com/audeering/audresample), [numpy](https://numpy.org), [librosa](https://librosa.org) for audio processing.
+- Thanks to [dacite](https://github.com/konradhalas/dacite) for config management.
+
+## License
+
+Apache 2.0

parakeet_mlx-0.1.0/README.md

@@ -0,0 +1,151 @@
+# Parakeet MLX
+
+An implementation of the Parakeet models - Nvidia's ASR(Automatic Speech Recognition) models - for Apple Silicon using MLX.
+
+> Currently only for Parakeet TDT models. Support for additional Parakeet model variants is planned.
+
+## Installation
+
+Using [uv](https://docs.astral.sh/uv/) - recommended way:
+
+```bash
+uv add git+https://github.com/senstella/parakeet-mlx
+```
+
+Or, for the CLI:
+
+```bash
+uv tool install git+https://github.com/senstella/parakeet-mlx
+```
+
+Using pip:
+
+```bash
+pip install git+https://github.com/senstella/parakeet-mlx
+```
+
+## CLI Quick Start
+
+```bash
+parakeet-mlx <audio_files> [OPTIONS]
+```
+
+## Arguments
+
+- `audio_files`: One or more audio files to transcribe (WAV, MP3, etc.)
+
+## Options
+
+- `--model` (default: `senstella/parakeet-tdt-0.6b-v2-mlx`)
+  - Hugging Face repository of the model to use
+
+- `--output-dir` (default: current directory)
+  - Directory to save transcription outputs
+
+- `--output-format` (default: srt)
+  - Output format (txt/srt/vtt/json/all)
+
+- `--output-template` (default: `{filename}`)
+  - Template for output filenames, `{filename}`, `{index}`, `{date}` is supported.
+
+- `--highlight-words` (default: False)
+  - Enable word-level timestamps in SRT/VTT outputs
+
+- `--verbose` / `-v` (default: False)
+  - Print detailed progress information
+
+## Examples
+
+```bash
+# Basic transcription
+parakeet-mlx audio.mp3
+
+# Multiple files with word-level timestamps of VTT subtitle
+parakeet-mlx *.mp3 --output-format vtt --highlight-words
+
+# Generate all output formats
+parakeet-mlx audio.mp3 --output-format all
+```
+
+
+## Python API Quick Start
+
+Transcribe a file:
+
+```py
+from parakeet_mlx import from_pretrained
+
+model = from_pretrained("senstella/parakeet-tdt-0.6b-v2-mlx")
+
+result = model.transcribe("audio_file.wav")
+
+print(result.text)
+```
+
+Check timestamps:
+
+```py
+from parakeet_mlx import from_pretrained
+
+model = from_pretrained("senstella/parakeet-tdt-0.6b-v2-mlx")
+
+result = model.transcribe("audio_file.wav")
+
+print(result.sentences)
+# [AlignedSentence(text="Hello World.", start=1.01, end=2.04, duration=1.03, tokens=[...])]
+```
+
+## Timestamp Result
+
+- `AlignedResult`: Top-level result containing the full text and sentences
+  - `text`: Full transcribed text
+  - `sentences`: List of `AlignedSentence`
+- `AlignedSentence`: Sentence-level alignments with start/end times
+  - `text`: Sentence text
+  - `start`: Start time in seconds
+  - `end`: End time in seconds
+  - `duration`: Between `start` and `end`.
+  - `tokens`: List of `AlignedToken`
+- `AlignedToken`: Word/token-level alignments with precise timestamps
+  - `text`: Token text
+  - `start`: Start time in seconds
+  - `end`: End time in seconds
+  - `duration`: Between `start` and `end`.
+
+## Low-Level API
+
+To transcribe log-mel spectrum directly, you can do the following:
+
+```python
+import mlx.core as mx
+from parakeet_mlx.audio import get_logmel, load_audio
+
+# Load and preprocess audio manually
+audio = load_audio("audio.wav", model.preprocessor_config.sample_rate)
+mel = get_logmel(audio, model.preprocessor_config)
+
+# Generate transcription with alignments
+# Accepts both [batch, sequence, feat] and [sequence, feat]
+# `alignments` is list of AlignedResult. (no matter you fed batch dimension or not!)
+alignments = model.generate(mel)
+```
+
+## Todo
+
+- [X] Add CLI for better usability
+- [ ] Streaming input (Although RTF is MUCH higher than 1 currently - it should be much sufficient to stream with current state)
+- [ ] Compiling for RNNT decoder
+- [ ] Add support for other Parakeet varients
+- [ ] Remove librosa dependency
+
+
+## Acknowledgments
+
+- Thanks to [Nvidia](https://www.nvidia.com/) for training this awesome models and writing cool papers and providing nice implementation.
+- Thanks to [MLX](https://github.com/ml-explore/mlx) project for providing the framework that made this implementation possible.
+- Thanks to [audiofile](https://github.com/audeering/audiofile) and [audresample](https://github.com/audeering/audresample), [numpy](https://numpy.org), [librosa](https://librosa.org) for audio processing.
+- Thanks to [dacite](https://github.com/konradhalas/dacite) for config management.
+
+## License
+
+Apache 2.0

parakeet_mlx-0.1.0/parakeet_mlx/__init__.py

@@ -0,0 +1,12 @@
+from parakeet_mlx.alignment import AlignedResult, AlignedSentence, AlignedToken
+from parakeet_mlx.parakeet import ParakeetTDT, ParakeetTDTArgs
+from parakeet_mlx.utils import from_pretrained
+
+__all__ = [
+    "ParakeetTDTArgs",
+    "ParakeetTDT",
+    "from_pretrained",
+    "AlignedResult",
+    "AlignedSentence",
+    "AlignedToken",
+]

parakeet_mlx-0.1.0/parakeet_mlx/alignment.py

@@ -0,0 +1,64 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class AlignedToken:
+    id: int
+    text: str
+    start: float
+    duration: float
+    end: float = 0.0  # temporary
+
+    def __post_init__(self) -> None:
+        self.end = self.start + self.duration
+
+
+@dataclass
+class AlignedSentence:
+    text: str
+    tokens: list[AlignedToken]
+    start: float = 0.0  # temporary
+    end: float = 0.0  # temporary
+    duration: float = 0.0  # temporary
+
+    def __post_init__(self) -> None:
+        self.tokens = list(sorted(self.tokens, key=lambda x: x.start))
+        self.start = self.tokens[0].start
+        self.end = self.tokens[-1].end
+        self.duration = self.end - self.start
+
+
+@dataclass
+class AlignedResult:
+    text: str
+    sentences: list[AlignedSentence]
+
+    def __post_init__(self) -> None:
+        self.text = self.text.strip()
+
+
+def tokens_to_sentences(tokens: list[AlignedToken]) -> list[AlignedSentence]:
+    sentences = []
+    current_tokens = []
+
+    for token in tokens:
+        current_tokens.append(token)
+
+        # hacky, will fix
+        if "." in token.text or "!" in token.text or "?" in token.text:  # type: ignore
+            sentence_text = "".join(t.text for t in current_tokens)
+            sentence = AlignedSentence(text=sentence_text, tokens=current_tokens)
+            sentences.append(sentence)
+
+            current_tokens = []
+
+    if current_tokens:
+        sentence_text = "".join(t.text for t in current_tokens)
+        sentence = AlignedSentence(text=sentence_text, tokens=current_tokens)
+        sentences.append(sentence)
+
+    return sentences
+
+
+def sentences_to_result(sentences: list[AlignedSentence]) -> AlignedResult:
+    return AlignedResult("".join(sentence.text for sentence in sentences), sentences)