thiagohgl commited on
Commit
54ec0b9
·
1 Parent(s): 28d0c5f

Updated README

Browse files
Files changed (1) hide show
  1. README.md +15 -12
README.md CHANGED
@@ -1,24 +1,27 @@
1
- ## Motivation
2
- This tool uses AI to evaluate your pronunciation so you can be understood more clearly. To directly test the tool, go to https://aipronunciationtr.com (please use the chrome browser for desktop).
3
-
4
- 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 okay” after your 10th try to not discourage you, even though you may still have some mistakes in your pronunciation.
5
 
6
- 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.
7
-
8
- 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 to other people trying to be better understood, so I decided to make a simple, more user friendly version of it.
9
 
10
  ## Installation
11
- To run the program, all you need to do is to install the requirements and run the main python file
12
  ```
13
  pip install -r requirements.txt
14
  python webApp.py
15
  ```
16
- The code is pure python, thus you should be able to run it without any major issue as long as you’re a using a recent python 3.X version.
17
 
18
  ## Online version
19
- 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 without any major issues in desktop-chrome, any other browser is not officially supported, although most of the functionality should work fine.
20
 
21
- Please be aware that the usage is limited by day (I’m still not rich ;) ). If, for some reason, you would like to skip the daily usage limit, just enter in contact and we can negotiate an additional API key only for you.
 
 
 
 
 
 
 
 
22
 
23
  ## Disclaimer
24
- Even though the tool can be useful, my intention here was not to make an industry-grade program with 100% test coverage, no errors and full support, but rather some easy to use tool that may be useful for some people even though it may not be perfect. Thus, be aware that some small bugs may be presented. In case you find something not working, all feedback is welcome and issues may be adressed depending on their severity.
 
 
 
 
 
1
 
2
+ # Ai Pronunciation Trainer
3
+ This tool uses AI to evaluate your pronunciation so you can improve it and be understood more clearly. To directly test the tool, go to https://aipronunciationtr.com (please use the chrome browser for desktop).
 
4
 
5
  ## Installation
6
+ To run the program locally, all you need to do is to install the requirements and run the main python file:
7
  ```
8
  pip install -r requirements.txt
9
  python webApp.py
10
  ```
11
+ The code is pure python; thus, you should be able to run it without any major issue as long as you’re using a recent python 3.X version.
12
 
13
  ## Online version
14
+ 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 without any major issues in desktop-chrome, any other browser is not officially supported, although most of the functionality should work fine.
15
 
16
+ Please be aware that the usage is limited by day (I’m still not rich ;)). If, for some reason, you would like to skip the daily usage limit, just enter in contact and we can negotiate an additional API key only for you.
17
+
18
+ ## Motivation
19
+
20
+ 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 okay” after your 10th try to not discourage you, even though you may still have some mistakes in your pronunciation.
21
+
22
+ 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.
23
+
24
+ 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 to other people trying to be better understood, so I decided to make a simple, more user-friendly version of it.
25
 
26
  ## Disclaimer
27
+ This is a simple tool 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.