alessandro trinca tornidor commited on
Commit
897eb87
1 Parent(s): f78a43f

docs: update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -10
README.md CHANGED
@@ -17,22 +17,32 @@ You can try my [refactored version](https://github.com/trincadev/ai-pronunciatio
17
 
18
  [![<https://aletrn-ai-pronunciation-trainer.hf.space/>](images/MainScreen.png)](https://aletrn-ai-pronunciation-trainer.hf.space/)
19
 
 
 
20
  ## Installation
21
 
22
- To run the program locally, you need to install the requirements and run the main python file:
 
23
 
24
  ```bash
25
  pip install -r requirements.txt
26
  python webApp.py
27
  ```
28
 
29
- You'll also need ffmpeg, which you can download from here <https://ffmpeg.org/download.html>. On Windows, 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".
 
30
 
31
  You should be able to run it locally without any major issues as long as you’re using a recent python 3.X version.
32
 
33
  ## Changes on [trincadev's](https://github.com/trincadev/) [repository](https://github.com/trincadev/ai-pronunciation-trainer)
34
 
35
- I upgraded the frontend (jquery@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](https://pypi.org/project/torch/) only until the library version [2.2.2](https://pypi.org/project/torch/2.2.2/)
 
 
 
 
 
 
36
  (see [this github issue](https://github.com/instructlab/instructlab/issues/1469) and [this deprecation notice](https://dev-discuss.pytorch.org/t/pytorch-macos-x86-builds-deprecation-starting-january-2024/1690)).
37
 
38
  ### E2E tests with playwright
@@ -68,7 +78,7 @@ pnpm playwright test
68
 
69
  ## Docker version
70
 
71
- Build the docker image this way:
72
 
73
  ```bash
74
  # clean any old active containers
@@ -87,12 +97,6 @@ Run the container (keep it on background) and show logs
87
  docker run -d -p 3000:3000 --name aip-trainer aip-trainer;docker logs -f aip-trainer
88
  ```
89
 
90
- ## Online version
91
-
92
- For the people who don’t feel comfortable running code or just want to have a quick way to use the tool, I hosted an online version of it at <https://aipronunciationtr.com>. It should work well in desktop-chrome, any other browser is not officially supported, although most of the functionality should work fine.
93
-
94
- Please be aware that the usage is limited by day (I’m still not rich ;)). If, for some reason, you would like to avoid the daily usage limit, just enter in contact and we see what we can do.
95
-
96
  ## Motivation
97
 
98
  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.
 
17
 
18
  [![<https://aletrn-ai-pronunciation-trainer.hf.space/>](images/MainScreen.png)](https://aletrn-ai-pronunciation-trainer.hf.space/)
19
 
20
+ My [HuggingFace Space](https://huggingface.co/spaces/aletrn/ai-pronunciation-trainer) is a free of charge: for this reason is the less powerful version and the speech recognition could take some seconds.
21
+
22
  ## Installation
23
 
24
+ To run the program locally, you need to install the requirements and run the main python file.
25
+ 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):
26
 
27
  ```bash
28
  pip install -r requirements.txt
29
  python webApp.py
30
  ```
31
 
32
+ 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.
33
+ 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".
34
 
35
  You should be able to run it locally without any major issues as long as you’re using a recent python 3.X version.
36
 
37
  ## Changes on [trincadev's](https://github.com/trincadev/) [repository](https://github.com/trincadev/ai-pronunciation-trainer)
38
 
39
+ Currently the best way to exec the project is using the Gradio frontend:
40
+
41
+ ```bash
42
+ python app.py
43
+ ```
44
+
45
+ I upgraded the old custom frontend (jquery@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](https://pypi.org/project/torch/) only until the library version [2.2.2](https://pypi.org/project/torch/2.2.2/)
46
  (see [this github issue](https://github.com/instructlab/instructlab/issues/1469) and [this deprecation notice](https://dev-discuss.pytorch.org/t/pytorch-macos-x86-builds-deprecation-starting-january-2024/1690)).
47
 
48
  ### E2E tests with playwright
 
78
 
79
  ## Docker version
80
 
81
+ Build the docker image this way (right now this version uses the old custom frontend with jquery):
82
 
83
  ```bash
84
  # clean any old active containers
 
97
  docker run -d -p 3000:3000 --name aip-trainer aip-trainer;docker logs -f aip-trainer
98
  ```
99
 
 
 
 
 
 
 
100
  ## Motivation
101
 
102
  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.