Hugging Face's logo

Spaces:
aletrn
/
ai-pronunciation-trainer
Running

App Files Community
ai-pronunciation-trainer / README.md
alessandro trinca tornidor
doc: update README.md adding stats about mutation tests
d3be968
preview code
|
raw
history blame
7.48 kB
metadata
title: AI Pronunciation Trainer
emoji: 🎤
colorFrom: red
colorTo: blue
sdk: gradio
sdk_version: 5.6.0
app_file: app.py
pinned: false
license: mit

AI Pronunciation Trainer

This repository refactor Thiagohgl's AI Pronunciation Trainer project, a tool that uses AI to evaluate your pronunciation so you can improve it and be understood more clearly. You can try my refactored version both locally or online, using my HuggingFace Space:

<https://aletrn-ai-pronunciation-trainer.hf.space/>

My HuggingFace Space is free of charge: for this reason is the less powerful version and the speech recognition could take some seconds.

Installation

To run the program locally, you need to install the requirements and run the main python file. These commands assume you have an active virtualenv (locally I'm using python 3.12, on HuggingFace the gradio SDK - version 5.6.0 at the moment - uses python 3.10):

pip install -r requirements.txt
python webApp.py

On Windows you can also use WSL2 to spin a Linux instance on your installation, then you don't need any particular requirements to work on it. You'll also need ffmpeg, which you can download from here https://ffmpeg.org/download.html. You can install it on base Windows using the command winget install ffmpeg, it may be needed to add the ffmpeg "bin" folder to your PATH environment variable. On Mac, you can also just run "brew install ffmpeg".

You should be able to run it locally without any major issues as long as you’re using a recent python 3.X version.

Changes on trincadev's repository

Currently the best way to exec the project is using the Gradio frontend:

python app.py

I upgraded the old custom frontend (iQuery@3.7.1, Bootstrap@5.3.3) and backend (pytorch==2.5.1, torchaudio==2.5.1) libraries. On macOS intel it's possible to install from pypi.org only until the library version 2.2.2 (see this github issue and this deprecation notice).

In case of missing TTS voices needed by the Text-to-Speech in-browser SpeechSynthesis feature (e.g. on Windows 11 you need to install manually the TTS voices for the languages you need), right now the Gradio frontend raises an alert message with a JavaScript message. In this case the TTS in-browser feature isn't usable and the users should use the backend TTS feature.

Python test cases (also enhanced with a mutation test suite)

After reaching a test coverage of 89%, I tried the cosmic-ray mutant test suite and I found out that I missed some spots. For this reason I started to improve my test cases (one module at time to avoid waiting too long):

python .venv312/bin/cosmic-ray init cosmic_ray_config.toml cosmic_ray.sqlite
python .venv312/bin/cosmic-ray --verbosity=INFO baseline cosmic_ray_config.toml
python .venv312/bin/cosmic-ray exec cosmic_ray_config.toml cosmic_ray.sqlite
cr-html cosmic_ray.sqlite > tmp/cosmic-ray-speechtoscore.html

The cosmic_ray_config.toml I'm using now (the tests for the lambdaSpeechToScore module are in two different files to avoid too code in only one):

[cosmic-ray]
module-path = "aip_trainer/lambdas/lambdaSpeechToScore.py"
timeout = 30.0
excluded-modules = []
test-command = "python -m pytest tests/lambdas/test_lambdaSpeechToScore.py tests/lambdas/test_lambdaSpeechToScore_librosa.py"

[cosmic-ray.distributor]
name = "local"

In this case my 'mutant' test coverage progression (Total jobs: 377 / Complete: 377, 100.00%):

  1. Surviving mutants: 181 (48.01%)
  2. Surviving mutants: 74 (19.63%)
  3. Surviving mutants: 3 (0.80%)

E2E tests with playwright

Normally I use Visual Studio Code to write and execute my playwright tests, however it's always possible to run them from cli (from the static folder, using a node package manager like npm or pnpm):

pnpm install
pnpm playwright test

Unused classes and functions (now removed)

  • aip_trainer.lambdas.lambdaTTS.*
  • aip_trainer.models.models.getTTSModel()
  • aip_trainer.models.models.getTranslationModel()
  • aip_trainer.models.AllModels.NeuralTTS
  • aip_trainer.models.AllModels.NeuralTranslator

DONE

  • upgrade iQuery>3.x
  • upgrade pytorch>2.x
  • e2e playwright tests
  • add an updated online version (HuggingFace)
  • refactor frontend moving from iQuery to gradio

TODO

  • save the synthetic audio speech from the text-to-speech voice as an audio file to play within the Gradio audio component
  • play the isolated words in the recordings, to compare the 'ideal' pronunciation with the learner pronunciation (now it's possible on the old frontend, complicated to implement with Gradio - waiting for this)
  • improve documentation (especially function docstrings), backend tests
  • move from pytorch to onnxruntime (if possible)
  • add more e2e tests with playwright

Docker version

Build the docker image this way (right now this version uses the old custom frontend with jQuery):

# clean any old active containers
docker stop $(docker ps -a -q); docker rm $(docker ps -a -q)

# build the base docker image
docker build . -f dockerfiles/dockerfile-base --progress=plain -t registry.gitlab.com/aletrn/ai-pronunciation-trainer:0.5.0

# build the final docker image
docker build . --progress=plain --name

Run the container (keep it on background) and show logs

docker run -d -p 3000:3000 --name aip-trainer aip-trainer;docker logs -f aip-trainer

Motivation

Often, when we want to improve our pronunciation, it is very difficult to self-assess how good we’re speaking. Asking a native, or language instructor, to constantly correct us is either impractical, due to monetary constrains, or annoying due to simply being too boring for this other person. Additionally, they may often say “it sounds good” after your 10th try to not discourage you, even though you may still have some mistakes in your pronunciation.

The AI pronunciation trainer is a way to provide objective feedback on how well your pronunciation is in an automatic and scalable fashion, so the only limit to your improvement is your own dedication.

This project originated from a small program that I did to improve my own pronunciation. When I finished it, I believed it could be a useful tool also for other people trying to be better understood, so I decided to make a simple, more user-friendly version of it.

Disclaimer

This is a simple project that I made in my free time with the goal to be useful to some people. It is not perfect, thus be aware that some small bugs may be present. In case you find something is not working, all feedback is welcome, and issues may be addressed depending on their severity.