ailuntz commited on
Commit
6d451ed
·
verified ·
1 Parent(s): 50ed323

Refresh MLX model card layout

Browse files
Files changed (1) hide show
  1. README.md +16 -185
README.md CHANGED
@@ -1,202 +1,33 @@
1
  ---
2
- license: mit
3
- base_model: XiaomiMiMo/MiMo-Audio-Tokenizer
 
 
4
  tags:
5
  - mlx
6
- - speech
7
  - audio-tokenizer
8
- - automatic-speech-recognition
9
  ---
10
- <div align="center">
11
- <picture>
12
- <source srcset="https://github.com/XiaomiMiMo/MiMo-VL/raw/main/figures/Xiaomi_MiMo_darkmode.png?raw=true" media="(prefers-color-scheme: dark)">
13
- <img src="https://github.com/XiaomiMiMo/MiMo-VL/raw/main/figures/Xiaomi_MiMo.png?raw=true" width="60%" alt="Xiaomi-MiMo" />
14
- </picture>
15
- </div>
16
 
17
- <h3 align="center">
18
- <b>
19
- <span>━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</span>
20
- <br/>
21
- MiMo Audio: Audio Language Models are Few-Shot Learners
22
- <br/>
23
- <span>━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━</span>
24
- <br/>
25
- </b>
26
- </h3>
27
 
28
- <br/>
29
 
30
- <div align="center" style="line-height: 1;">
31
- |
32
- <a href="https://huggingface.co/collections/XiaomiMiMo/mimo-audio-68cc7202692c27dae881cce0" target="_blank">🤗 HuggingFace</a>
33
- &nbsp;|
34
- <a href="https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/MiMo-Audio-Technical-Report.pdf" target="_blank">📄 Paper</a>
35
- &nbsp;|
36
- <a href="https://xiaomimimo.github.io/MiMo-Audio-Demo" target="_blank">📰 Blog</a>
37
- &nbsp;|
38
- <a href="https://huggingface.co/spaces/XiaomiMiMo/mimo_audio_chat" target="_blank">🔥 Online Demo</a>
39
- &nbsp;|
40
- <a href="https://github.com/XiaomiMiMo/MiMo-Audio-Eval" target="_blank">📊 MiMo-Audio-Eval</a>
41
- &nbsp;|
42
 
43
- <br/>
44
- </div>
45
-
46
- <br/>
47
-
48
- ## MLX Conversion
49
-
50
- This repository is the MLX export used by `mlx-community/MiMo-V2.5-ASR-MLX`.
51
-
52
- - Default precision is `fp32`.
53
- - This export keeps the encoder and RVQ path used by MiMo ASR.
54
- - Decoder and vocoder weights are omitted here because they are not used in the ASR pipeline.
55
- - The published MLX weights are therefore an ASR-focused inference subset, not a byte-for-byte mirror of the full official tokenizer release.
56
-
57
- ## MLX Usage
58
-
59
- Current MLX usage is documented in:
60
-
61
- - [ailuntx/MiMo-V2.5-ASR-MLX](https://github.com/ailuntx/MiMo-V2.5-ASR-MLX)
62
- - [ailuntx/MiMo-Audio-Tokenizer-MLX](https://github.com/ailuntx/MiMo-Audio-Tokenizer-MLX)
63
-
64
- Install the current MLX path:
65
-
66
- ```bash
67
- pip install git+https://github.com/ailuntx/mlx-audio@feat/mimo-v25-asr
68
- ```
69
-
70
- Download the tokenizer:
71
-
72
- ```bash
73
- hf download mlx-community/MiMo-Audio-Tokenizer --local-dir ./models/MiMo-Audio-Tokenizer
74
- ```
75
-
76
- This tokenizer is consumed automatically by:
77
-
78
- - [mlx-community/MiMo-V2.5-ASR-MLX](https://huggingface.co/mlx-community/MiMo-V2.5-ASR-MLX)
79
-
80
- If you are following the standalone GitHub path, clone the MiMo ASR fork and use its helper script:
81
 
82
  ```bash
83
  git clone https://github.com/ailuntx/MiMo-V2.5-ASR-MLX.git
84
  cd MiMo-V2.5-ASR-MLX
85
- python run_mimo_asr_mlx.py \
86
- --model ./models/MiMo-V2.5-ASR-MLX \
87
- --audio path/to/audio.wav
88
- ```
89
-
90
- Notes:
91
-
92
- - `mlx-community/MiMo-V2.5-ASR-MLX` resolves this tokenizer through `mlx_manifest.json`.
93
- - This repo is not meant to be the primary user entrypoint; use the MiMo ASR repo above for end-to-end transcription.
94
-
95
- ## Introduction
96
-
97
- Existing audio language models typically rely on task-specific fine-tuning to accomplish particular audio tasks. In contrast, humans are able to generalize to new audio tasks with only a few examples or simple instructions. GPT-3 has shown that scaling next-token prediction pretraining enables strong generalization capabilities in text, and we believe this paradigm is equally applicable to the audio domain. By scaling MiMo-Audio's pretraining data to over one hundred million of hours, we observe the emergence of few-shot learning capabilities across a diverse set of audio tasks. We develop a systematic evaluation of these capabilities and find that MiMo-Audio-7B-Base achieves SOTA performance on both speech intelligence and audio understanding benchmarks among open-source models. Beyond standard metrics, MiMo-Audio-7B-Base generalizes to tasks absent from its training data, such as voice conversion, style transfer, and speech editing. MiMo-Audio-7B-Base also demonstrates powerful speech continuation capabilities, capable of generating highly realistic talk shows, recitations, livestreaming and debates. At the post-training stage, we curate a diverse instruction-tuning corpus and introduce thinking mechanisms into both audio understanding and generation. MiMo-Audio-7B-Instruct achieves open-source SOTA on audio understanding benchmarks, spoken dialogue benchmarks and instruct-TTS evaluations, approaching or surpassing closed-source models.
98
-
99
- <p align="center">
100
- <img width="95%" src="https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/assets/Results.png?raw=true">
101
- </p>
102
-
103
- ## Architecture
104
-
105
- ### MiMo-Audio-Tokenizer
106
-
107
- MiMo-Audio-Tokenizer is a 1.2B-parameter Transformer operating at 25 Hz. It employs an eight-layer RVQ stack to generate 200 tokens per second. By jointly optimizing semantic and reconstruction objectives, we train MiMo-Audio-Tokenizer from scratch on a 10-million-hour corpus, achieving superior reconstruction quality and facilitating downstream language modeling.
108
-
109
- For clarity: the official Xiaomi release above describes the full tokenizer stack. This MLX repository publishes the encoder/RVQ subset used by `MiMo-V2.5-ASR`, which is why the Hugging Face file summary for this repo is about `0.64B` parameters instead of the full `1.2B`.
110
-
111
- <p align="center">
112
- <img width="95%" src="https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/assets/tokenizer.png?raw=true">
113
- </p>
114
-
115
- MiMo-Audio couples a patch encoder, an LLM, and a patch decoder to improve modeling efficiency for high-rate sequences and bridge the length mismatch between speech and text. The patch encoder aggregates four consecutive time steps of RVQ tokens into a single patch, downsampling the sequence to a 6.25 Hz representation for the LLM. The patch decoder autoregressively generates the full 25 Hz RVQ token sequence via a delayed-generation scheme.
116
 
117
- ### MiMo-Audio
118
-
119
- <p align="center">
120
- <img width="95%" src="https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/assets/architecture.png?raw=true">
121
- </p>
122
-
123
- ## Explore MiMo-Audio Now! 🚀🚀🚀
124
-
125
- - 🎧 **Try the Hugging Face demo:** [MiMo-Audio Demo](https://huggingface.co/spaces/XiaomiMiMo/mimo_audio_chat)
126
- - 📰 **Read the Official Blog:** [MiMo-Audio Blog](https://xiaomimimo.github.io/MiMo-Audio-Demo)
127
- - 📄 **Dive into the Technical Report:** [MiMo-Audio Technical Report](https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/MiMo-Audio-Technical-Report.pdf)
128
-
129
- ## Model Download
130
-
131
- | Models | 🤗 Hugging Face |
132
- |-------|-------|
133
- | MiMo-Audio-Tokenizer | [XiaomiMiMo/MiMo-Audio-Tokenizer](https://huggingface.co/XiaomiMiMo/MiMo-Audio-Tokenizer) |
134
- | MiMo-Audio-7B-Base | [XiaomiMiMo/MiMo-Audio-7B-Base](https://huggingface.co/XiaomiMiMo/MiMo-Audio-7B-Base) |
135
- | MiMo-Audio-7B-Instruct | [XiaomiMiMo/MiMo-Audio-7B-Instruct](https://huggingface.co/XiaomiMiMo/MiMo-Audio-7B-Instruct) |
136
-
137
- ## Getting Started
138
-
139
- Spin up the MiMo-Audio demo in minutes with the built-in Gradio app.
140
-
141
- ### Installation
142
-
143
- ```sh
144
- git clone https://github.com/XiaomiMiMo/MiMo-Audio.git
145
- cd MiMo-Audio
146
- pip install -e .
147
- ```
148
-
149
- ### Run the demo
150
-
151
- ```sh
152
- python run_mimo_audio.py
153
- ```
154
-
155
- This launches a local Gradio interface where you can try MiMo-Audio interactively.
156
-
157
- <p align="center">
158
- <img width="95%" src="https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/assets/demo_ui.jpg?raw=true">
159
- </p>
160
-
161
- Enter the local paths for `MiMo-Audio-Tokenizer` and `MiMo-Audio-7B-Instruct`, then enjoy the full functionality of MiMo-Audio!
162
-
163
- ## Inference Scripts
164
-
165
- ### Base Model
166
-
167
- We provide an example script to explore the **in-context learning** capabilities of `MiMo-Audio-7B-Base`.
168
- See: [`inference_example_pretrain.py`](https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/inference_example_pretrain.py)
169
-
170
- ### Instruct Model
171
-
172
- To try the instruction-tuned model `MiMo-Audio-7B-Instruct`, use the corresponding inference script.
173
- See: [`inference_example_sft.py`](https://github.com/XiaomiMiMo/MiMo-Audio/blob/main/inference_example_sft.py)
174
-
175
- ## Evaluation Toolkit
176
-
177
- Full evaluation suite are available at 🌐[MiMo-Audio-Eval](https://github.com/XiaomiMiMo/MiMo-Audio-Eval).
178
-
179
- This toolkit is designed to evaluate MiMo-Audio and other recent audio LLMs as mentioned in the paper. It provides a flexible and extensible framework, supporting a wide range of datasets, tasks, and models.
180
-
181
- ## Validation
182
-
183
- This MLX export was validated locally with `mlx-audio-swift` and `MiMo-V2.5-ASR-MLX`.
184
-
185
- - Smoke samples: `intention.wav`, `conversational_a.wav`, `noisy_audio.wav`
186
- - Release precision: `fp32`
187
- - Lower-precision internal experiments were kept out of the Hub release to avoid frontend drift and naming ambiguity
188
-
189
- ## Citation
190
-
191
- ```bibtex
192
- @misc{coreteam2025mimoaudio,
193
- title={MiMo-Audio: Audio Language Models are Few-Shot Learners},
194
- author={LLM-Core-Team Xiaomi},
195
- year={2025},
196
- url={GitHub - XiaomiMiMo/MiMo-Audio},
197
- }
198
  ```
199
 
200
- ## Contact
201
 
202
- Please contact us at [mimo@xiaomi.com](mailto:mimo@xiaomi.com) or open an issue if you have any questions.
 
1
  ---
2
+ license: apache-2.0
3
+ library_name: mlx
4
+ base_model:
5
+ - XiaomiMiMo/MiMo-V2.5-ASR
6
  tags:
7
  - mlx
8
+ - apple-silicon
9
  - audio-tokenizer
10
+ - mimo
11
  ---
 
 
 
 
 
 
12
 
13
+ Part of the [MiMo V2.5 ASR MLX](https://huggingface.co/collections/mlx-community/mimo-v25-asr-6a02cb99466d6a36475a4d70) collection.
 
 
 
 
 
 
 
 
 
14
 
15
+ # MiMo Audio Tokenizer (MLX)
16
 
17
+ Audio tokenizer assets for the community MLX conversion of [XiaomiMiMo/MiMo-V2.5-ASR](https://github.com/XiaomiMiMo/MiMo-V2.5-ASR).
 
 
 
 
 
 
 
 
 
 
 
18
 
19
+ ## Quick Start
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
 
21
  ```bash
22
  git clone https://github.com/ailuntx/MiMo-V2.5-ASR-MLX.git
23
  cd MiMo-V2.5-ASR-MLX
24
+ pip install git+https://github.com/ailuntx/mlx-audio.git
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
 
26
+ hf download mlx-community/MiMo-Audio-Tokenizer --local-dir ./models/MiMo-Audio-Tokenizer
27
+ hf download mlx-community/MiMo-V2.5-ASR-MLX --local-dir ./models/MiMo-V2.5-ASR-MLX
28
+ python run_mimo_asr_mlx.py --model ./models/MiMo-V2.5-ASR-MLX --audio path/to/audio.wav
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
  ```
30
 
31
+ ## Notes
32
 
33
+ This repository is a required companion asset for the MiMo ASR MLX model repositories. Keep it next to the model checkpoint or pass its path through the runtime configuration.