Skip to main content

OpenPronounce

Open-source, phoneme-level English pronunciation assessment.
Give it a recording and the sentence that was supposed to be said. Get a score, the mispronounced words with expected vs. heard phonemes (IPA), the transcription and the prosody curves. Runs on your machine, on CPU.

Open in Colab Tests License: MIT Sponsor

OpenPronounce web application: score, mispronounced words, phoneme and prosody charts

$ openpronounce recording.wav "Hello, how are you?"
Score        : 55.74/100
Transcription: HELL NO WHO ARE YOU
Heard phones : /h ɛ l n oʊ h u ɑɹ j u/
Mispronounced:
  - hello: expected /həloʊ/, heard /hɛlnoʊ/
  - how: expected /haʊ/, heard /hu/

Commercial APIs (Azure Speech Pronunciation Assessment, SpeechAce, ELSA...) do this behind a paywall and a network call. OpenPronounce is the self-hosted, MIT-licensed building block for language-learning apps, EdTech products and research: no API key, no per-minute billing, your learners' voices stay on your servers.

What you get

For each recording, a JSON-serializable dict:

Field Meaning
score 0-100 overall pronunciation score
transcribe what the model actually heard (Wav2Vec2 CTC)
differences.errors[] one entry per mispronounced or missing word: word, expected (IPA), actual (IPA, what was really heard), position
differences.heard_phones, differences.expected_phones the phones recognized in the audio, and the phones expected for each word
differences.words_with_errors the words to work on
differences.phoneme_error_rate, differences.word_error_rate edited phonemes / expected phonemes, edited words / expected words
differences.expected_phonemes, differences.transcribed_phonemes full phoneme sequences
differences.expected_vector, differences.transcribed_vector DTW-aligned phoneme traces, ready to plot
acoustic_distance mean per-frame DTW distance between the learner's Wav2Vec2 embeddings and a synthetic reference
prosody.f0, prosody.energy pitch and loudness contours

Quickstart

Install

Requires Python 3.10+, ffmpeg and espeak-ng on the system (apt install ffmpeg espeak-ng, brew install ffmpeg espeak-ng).

pip install torch --index-url https://download.pytorch.org/whl/cpu   # CPU wheels, much smaller
pip install git+https://github.com/Halleck45/OpenPronounce.git

Two Wav2Vec2 checkpoints (~1.2 GB each) are downloaded from the Hugging Face Hub on first use: facebook/wav2vec2-large-960h (words) and facebook/wav2vec2-lv-60-espeak-cv-ft (phones). Set OPENPRONOUNCE_PHONEME_MODEL=off to skip the second one; word errors are then inferred from the transcription, which is less precise.

Command line

openpronounce recording.wav "Hello, I am a developer"
openpronounce recording.mp3 "Hello, I am a developer" --json --no-prosody   # machine-readable

Python

from openpronounce import load_audio, compare_audio_with_text

sound = load_audio("recording.wav")          # any format ffmpeg reads, resampled to 16 kHz mono
result = compare_audio_with_text(sound, "Hello, I am a developer")

print(result["score"])                       # 97.36
for err in result["differences"]["errors"]:
    print(err["word"], err["expected"], "->", err["actual"] or "(missing)")

Lower-level building blocks are exposed too: transcribe(sound), get_phonemes(text), compare_transcriptions(heard_text, expected_text).

Docker

docker build -t openpronounce .
docker run -p 8000:8000 openpronounce
# open http://localhost:8000

Web application (FastAPI)

pip install "openpronounce[app] @ git+https://github.com/Halleck45/OpenPronounce.git"
git clone https://github.com/Halleck45/OpenPronounce.git && cd OpenPronounce
uvicorn server:app --host 0.0.0.0 --port 8000

The UI records from the microphone, scores the sentence, animates a mouth (visemes) and plots the phoneme traces and prosody. Browsers only allow microphone access on https:// or localhost.

Endpoint Body (multipart form) Returns
POST /pronunciation file, expected_text full analysis (see above)
POST /speech2text file {"transcript": ...}
POST /phonemes text {"phonemes": [...], "words": [...]}
POST /tts text reference pronunciation, 16 kHz wav
GET /health {"status": "ok"}

Interactive docs at /docs (Swagger UI).

Streamlit

streamlit run streamlit_app.py

Notebook

Open in Colab: load a sample, score it, print the phoneme errors, plot the prosody, then try your own recording. No local setup.

How it works

  1. Phones: a Wav2Vec2 model fine-tuned on espeak labels (wav2vec2-lv-60-espeak-cv-ft) recognizes the phones actually said, straight from the audio. No word-level language model gets a chance to "correct" the learner.
  2. Expected phones: the sentence is phonemized with espeak-ng (IPA), word by word. Both sequences are normalized (length marks dropped, reduced vowels merged, cot-caught merger, a few function words with alternate pronunciations).
  3. Alignment: expected and heard phones are aligned with edit-distance opcodes; each word is compared with the phones it aligned to and reported when half of them (or 3 or more) are wrong. Thresholds: phones.PHONE_ERROR_THRESHOLD, phones.PHONE_ERROR_MIN_EDITS.
  4. Words: the audio is also transcribed with wav2vec2-large-960h for the transcription and the word error rate.
  5. Acoustics: the sentence is synthesized (gTTS), both recordings are encoded with Wav2Vec2 and aligned with DTW; the mean per-frame distance is the acoustic_distance.
  6. Prosody: F0 (pYIN) and RMS energy contours.

The approach is described in this blog post.

The score

score = 0.2 × acoustic + 0.5 × (1 − phoneme error rate) + 0.3 × (1 − word error rate), each term clipped to [0, 100]. The acoustic term maps the mean DTW distance linearly from 5 (100) to 15 (0); these bounds come from the bundled samples (assets/) and are exposed as speech.ACOUSTIC_DISTANCE_GOOD / speech.ACOUSTIC_DISTANCE_BAD if you want to recalibrate on your own data. All three terms are length-independent, so a long paragraph and a two-word sentence are scored on the same scale.

Visemes

The web UI ships a small phoneme-to-viseme mapping for English (HumanBeanCMU39 mouth shapes), enough to animate a talking mouth from the phoneme list:

import { Viseme } from "/static/viseme.js";
const viseme = new Viseme(document.getElementById("mouth"));
viseme.play(["həloʊ", "huː", "ɑːɹ", "juː"]);

Limitations

  • English only for now (en-us phonemization, English Wav2Vec2). Swapping the model and the espeak language is the path to other languages.
  • The reference voice comes from gTTS, so the first analysis of a given sentence needs network access; references are cached afterwards.
  • Wav2Vec2 was trained on native read speech (LibriSpeech). Very strong accents, children's voices and noisy recordings degrade the transcription, and therefore the feedback.
  • The phone recognizer itself has an error rate (about 10 % of phones on a clean native reading of the bundled Harvard sentences); expect an occasional false alarm on short words. This is a heuristic assessment, not a Goodness-of-Pronunciation model trained on annotated L2 speech.

Roadmap

Contributions welcome on any of these:

  • Publish on PyPI (pip install openpronounce)
  • Hosted demo (Hugging Face Space)
  • Offline TTS reference (piper / Kokoro) instead of gTTS
  • Per-phone confidence (CTC posteriors) to grade errors instead of a yes/no per word
  • Other languages
  • Benchmark on a public L2 dataset (speechocean762) to calibrate the score
  • GPU support in the Docker image

Contributing

git clone https://github.com/Halleck45/OpenPronounce.git && cd OpenPronounce
python -m venv .venv && source .venv/bin/activate
pip install torch --index-url https://download.pytorch.org/whl/cpu
pip install -e ".[app,dev]"
pytest

Tests do not need the network nor the model weights (model calls are mocked); espeak-ng must be installed.

References

License

MIT, see LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openpronounce-0.2.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openpronounce-0.2.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file openpronounce-0.2.0.tar.gz.

File metadata

  • Download URL: openpronounce-0.2.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for openpronounce-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1ff2f4dda16e8cec9cbba9997878e787c33537c19c8e075879c6a257051eb462
MD5 526a83840bf325ac87e73e235b5e3f29
BLAKE2b-256 5c9a28b63775abd637a9a4684124a51c8d36303a6843904a4f45dd905de71185

See more details on using hashes here.

File details

Details for the file openpronounce-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: openpronounce-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.3

File hashes

Hashes for openpronounce-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 19ba2edb072fff50b900628d4ea63fe482ba46db1fadf24d3028ae5aa9b0cd3c
MD5 028de1d9a709d417297e9f43d393070c
BLAKE2b-256 74320edc276413004cf3c4eec576f4b2435a081f06449a313b4b51bdc5e59973

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page