-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
90 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| https://creativecommons.org/licenses/by-nc/4.0/legalcode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # Model card for Czech STT | ||
|
|
||
| Jump to section: | ||
|
|
||
| - [Model details](#model-details) | ||
| - [Intended use](#intended-use) | ||
| - [Performance Factors](#performance-factors) | ||
| - [Metrics](#metrics) | ||
| - [Training data](#training-data) | ||
| - [Evaluation data](#evaluation-data) | ||
| - [Ethical considerations](#ethical-considerations) | ||
| - [Caveats and recommendations](#caveats-and-recommendations) | ||
|
|
||
| ## Model details | ||
|
|
||
| - Person or organization developing model: Originally trained by [Vojtěch Drábek](https://github.com/comodoro). | ||
| - Model language: Czech / čeština / `cs` | ||
| - Model date: April 9, 2021 | ||
| - Model type: `Speech-to-Text` | ||
| - Model version: `v0.1.0` | ||
| - Compatible with 🐸 STT version: `v0.9.3` | ||
| - License: CC-BY-NC | ||
| - Citation details: `@techreport{chuvash-stt, author = {Drábek,Vojtěch}, title = {Czech STT 0.1}, institution = {Coqui}, address = {\url{https://github.com/coqui-ai/STT-models}} year = {2021}, month = {April}, number = {STT-CV6.1-CS-0.1} }` | ||
| - Where to send questions or comments about the model: You can leave an issue on [`STT-model` issues](https://github.com/coqui-ai/STT-models/issues), open a new discussion on [`STT-model` discussions](https://github.com/coqui-ai/STT-models/discussions), or chat with us on [Gitter](https://gitter.im/coqui-ai/). | ||
|
|
||
| ## Intended use | ||
|
|
||
| Speech-to-Text for the [Czech Language](https://en.wikipedia.org/wiki/Czech_language) on 16kHz, mono-channel audio. | ||
|
|
||
| ## Performance Factors | ||
|
|
||
| Factors relevant to Speech-to-Text performance include but are not limited to speaker demographics, recording quality, and background noise. Read more about STT performance factors [here](https://stt.readthedocs.io/en/latest/DEPLOYMENT.html#how-will-a-model-perform-on-my-data). | ||
|
|
||
| ## Metrics | ||
|
|
||
| STT models are usually evaluated in terms of their transcription accuracy, deployment Real-Time Factor, and model size on disk. | ||
|
|
||
| #### Transcription Accuracy | ||
|
|
||
| More information reported on [Github](https://github.com/comodoro/deepspeech-cs/). | ||
|
|
||
| #### Real-Time Factor | ||
|
|
||
| Real-Time Factor (RTF) is defined as `processing-time / length-of-audio`. The exact real-time factor of an STT model will depend on the hardware setup, so you may experience a different RTF. | ||
|
|
||
| Recorded average RTF on laptop CPU: `` | ||
|
|
||
| #### Model Size | ||
|
|
||
| `model.pbmm`: 181M | ||
| `model.tflite`: 46M | ||
|
|
||
| ### Approaches to uncertainty and variability | ||
|
|
||
| Confidence scores and multiple paths from the decoding beam can be used to measure model uncertainty and provide multiple, variable transcripts for any processed audio. | ||
|
|
||
| ## Training data | ||
|
|
||
| This model was trained on the following corpora: | ||
|
|
||
| 1. Vystadial 2016 – Czech data | ||
| 2. OVM – Otázky Václava Moravce | ||
| 3. Czech Parliament Meetings | ||
| 4. Large Corpus of Czech Parliament Plenary Hearings | ||
| 5. Common Voice Czech | ||
| 6. Some private recordings and parts of audioboooks | ||
|
|
||
| ## Evaluation data | ||
|
|
||
| N/A | ||
|
|
||
| ## Ethical considerations | ||
|
|
||
| Deploying a Speech-to-Text model into any production setting has ethical implications. You should consider these implications before use. | ||
|
|
||
| ### Demographic Bias | ||
|
|
||
| You should assume every machine learning model has demographic bias unless proven otherwise. For STT models, it is often the case that transcription accuracy is better for men than it is for women. If you are using this model in production, you should acknowledge this as a potential issue. | ||
|
|
||
| ### Surveillance | ||
|
|
||
| Speech-to-Text may be mis-used to invade the privacy of others by recording and mining information from private conversations. This kind of individual privacy is protected by law in may countries. You should not assume consent to record and analyze private speech. | ||
|
|
||
| ## Caveats and recommendations | ||
|
|
||
| Machine learning models (like this STT model) perform best on data that is similar to the data on which they were trained. Read about what to expect from an STT model with regard to your data [here](https://stt.readthedocs.io/en/latest/DEPLOYMENT.html#how-will-a-model-perform-on-my-data). | ||
|
|
||
| In most applications, it is recommended that you [train your own language model](https://stt.readthedocs.io/en/latest/LANGUAGE_MODEL.html) to improve transcription accuracy on your speech data. |