Skip to content

headers 1,3,4 -> headers 1,2,3 #1416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bquast wants to merge 1 commit into
base: main
Choose a base branch
from
Open

headers 1,3,4 -> headers 1,2,3 #1416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions whisper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/):

Expand All @@ -19,9 +19,9 @@ Install the `mlx-whisper` package with:
pip install mlx-whisper
```

### Run
## Run

#### CLI
### CLI

At its simplest:

Expand All @@ -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:

Expand Down Expand Up @@ -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
Expand Down