Skip to content

Commit

Permalink
Add new model directory
Browse files Browse the repository at this point in the history
  • Loading branch information
comodoro committed Jul 21, 2021
1 parent 29b60f9 commit ba87646
Show file tree
Hide file tree
Showing 3 changed files with 138 additions and 0 deletions.
1 change: 1 addition & 0 deletions czech/comodoro/v0.2.0/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://creativecommons.org/licenses/by-nc/4.0/legalcode
95 changes: 95 additions & 0 deletions czech/comodoro/v0.2.0/MODEL_CARD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# 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: July 21, 2021
- Model type: `Speech-to-Text`
- Model version: `v0.2.0`
- Compatible with 🐸 STT version: `v0.9.3`
- License: CC-BY-NC
- Citation details: `@techreport{czech-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 = {July}, number = {STT-CS-0.2} }`
- Where to send questions or comments about the model: You can leave an issue on [the model release page](https://github.com/comodoro/deepspeech-cs) or [`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/).

|Test Corpus|WER|CER|
|-----------|---|---|
|Common Voice|42.3\%|11.2\%|
|Vystadial 2016|50.8\%|19.6\%|
|Parliament Plenary Hearings|21.5\%|5.2\%|


#### 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

The model was evaluated on Common Voice Czech, Large Corpus of Czech Parliament Plenary Hearings and Vystadial 2016 – Czech data test sets.

## 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 many 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.
42 changes: 42 additions & 0 deletions czech/comodoro/v0.2.0/alphabet.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@

a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
á
é
í
ó
ú
ý
č
ď
ě
ň
ř
š
ť
ů
ž

0 comments on commit ba87646

Please sign in to comment.