Skip to content

Commit 69b2bf6

Browse files
Add soundfile to requirements and Quick Start in README (#8)
1 parent 577e635 commit 69b2bf6

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,23 @@ A text-to-speech (TTS) and Speech-to-Speech (STS) library built on Apple's MLX f
1515
pip install mlx-audio
1616
```
1717

18+
### Quick Start
19+
20+
To generate audio with an LLM use:
21+
22+
```bash
23+
# Basic usage
24+
mlx_audio.tts.generate --text "Hello, world"
25+
26+
# Specify prefix for output file
27+
mlx_audio.tts.generate --text "Hello, world" --file_prefix hello
28+
29+
# Adjust speaking speed (0.5-2.0)
30+
mlx_audio.tts.generate --text "Hello, world" --speed 1.4
31+
```
32+
33+
34+
1835
## Models
1936

2037
### Kokoro

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ transformers>=4.49.0
1313
sentencepiece>=0.2.0
1414
huggingface_hub>=0.27.0
1515
librosa>=0.10.2.post1
16+
soundfile>=0.13.1

0 commit comments

Comments
 (0)