wehub-resource-sync
e06fe8e8c6
Secret Leaks / trufflehog (push) Failing after 1s
Build documentation / build (push) Failing after 1s
Build documentation / build_other_lang (push) Failing after 0s
CodeQL Security Analysis / CodeQL Analysis (push) Failing after 0s
PR CI / pr-ci (push) Failing after 1s
Slow tests on important models (on Push - A10) / Get all modified files (push) Failing after 1s
Slow tests on important models (on Push - A10) / Model CI (push) Has been skipped
Self-hosted runner (benchmark) / Benchmark (aws-g5-4xlarge-cache) (push) Has been cancelled
New model PR merged notification / Notify new model (push) Has been cancelled
Update Transformers metadata / build_and_package (push) Has been cancelled
96 lines
3.4 KiB
Markdown
96 lines
3.4 KiB
Markdown
<!--Copyright 2025 The HuggingFace Team. All rights reserved.
|
|
|
|
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.
|
|
|
|
⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
|
|
rendered properly in your Markdown viewer.
|
|
|
|
-->
|
|
*This model was published in HF papers on 2024-10-21 and contributed to Hugging Face Transformers on 2025-01-10.*
|
|
|
|
<div style="float: right;">
|
|
<div class="flex flex-wrap space-x-1">
|
|
<img alt="FlashAttention" src="https://img.shields.io/badge/%E2%9A%A1%EF%B8%8E%20FlashAttention-eae0c8?style=flat">
|
|
<img alt="SDPA" src="https://img.shields.io/badge/SDPA-DE3412?style=flat&logo=pytorch&logoColor=white">
|
|
</div>
|
|
</div>
|
|
|
|
# Moonshine
|
|
|
|
[Moonshine](https://huggingface.co/papers/2410.15608) is an encoder-decoder speech recognition model optimized for real-time transcription and recognizing voice command. Instead of using traditional absolute position embeddings, Moonshine uses Rotary Position Embedding (RoPE) to handle speech with varying lengths without using padding. This improves efficiency during inference, making it ideal for resource-constrained devices.
|
|
|
|
You can find all the original Moonshine checkpoints under the [Useful Sensors](https://huggingface.co/UsefulSensors) organization.
|
|
|
|
> [!TIP]
|
|
> Click on the Moonshine models in the right sidebar for more examples of how to apply Moonshine to different speech recognition tasks.
|
|
|
|
The example below demonstrates how to transcribe speech into text with [`Pipeline`] or the [`AutoModel`] class.
|
|
|
|
<hfoptions id="usage">
|
|
<hfoption id="Pipeline">
|
|
|
|
```python
|
|
from transformers import pipeline
|
|
|
|
|
|
pipeline = pipeline(
|
|
task="automatic-speech-recognition",
|
|
model="UsefulSensors/moonshine-base",
|
|
device=0
|
|
)
|
|
pipeline("https://huggingface.co/datasets/Narsil/asr_dummy/resolve/main/mlk.flac")
|
|
```
|
|
|
|
</hfoption>
|
|
<hfoption id="AutoModel">
|
|
|
|
```python
|
|
from datasets import load_dataset
|
|
|
|
from transformers import AutoProcessor, MoonshineForConditionalGeneration
|
|
|
|
|
|
processor = AutoProcessor.from_pretrained("UsefulSensors/moonshine-base")
|
|
model = MoonshineForConditionalGeneration.from_pretrained("UsefulSensors/moonshine-base", device_map="auto")
|
|
|
|
ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", split="validation")
|
|
audio_sample = ds[0]["audio"]
|
|
|
|
input_features = processor(
|
|
audio_sample["array"],
|
|
sampling_rate=audio_sample["sampling_rate"],
|
|
return_tensors="pt"
|
|
)
|
|
input_features = input_features.to(model.device, dtype=model.dtype)
|
|
|
|
predicted_ids = model.generate(**input_features, cache_implementation="static")
|
|
transcription = processor.batch_decode(predicted_ids, skip_special_tokens=True)
|
|
print(transcription)
|
|
```
|
|
|
|
</hfoption>
|
|
</hfoptions>
|
|
|
|
## MoonshineConfig
|
|
|
|
[[autodoc]] MoonshineConfig
|
|
|
|
## MoonshineModel
|
|
|
|
[[autodoc]] MoonshineModel
|
|
- forward
|
|
- _mask_input_features
|
|
|
|
## MoonshineForConditionalGeneration
|
|
|
|
[[autodoc]] MoonshineForConditionalGeneration
|
|
- forward
|
|
- generate
|