From 3781cef92eb73a582b5c50e0fe74babc6ec19ccb Mon Sep 17 00:00:00 2001 From: Bastiaan Quast Date: Tue, 21 Apr 2026 19:07:06 +0200 Subject: [PATCH] headers 1,3,4 -> headers 1,2,3 This replaces the header structure using `#` (for the title) and then `###` + `####` with `##` + `###`. This is in line with the README.md files from the other folders, it also makes it easier to read (the difference between h3 and h4 is hard to spot). --- whisper/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/whisper/README.md b/whisper/README.md index cd3bc684a..98d67ec7b 100644 --- a/whisper/README.md +++ b/whisper/README.md @@ -4,7 +4,7 @@ Speech recognition with Whisper in MLX. Whisper is a set of open source speech recognition models from OpenAI, ranging from 39 million to 1.5 billion parameters.[^1] -### Setup +## Setup Install [`ffmpeg`](https://ffmpeg.org/): @@ -19,9 +19,9 @@ Install the `mlx-whisper` package with: pip install mlx-whisper ``` -### Run +## Run -#### CLI +### CLI At its simplest: @@ -44,7 +44,7 @@ some-process | mlx_whisper - The default output file name will be `content.*`. You can specify the name with the `--output-name` flag. -#### API +### API Transcribe audio with: @@ -82,7 +82,7 @@ To see more transcription options use: >>> help(mlx_whisper.transcribe) ``` -### Converting models +## Converting models > [!TIP] > Skip the conversion step by using pre-converted checkpoints from the Hugging