From 44462e9bd14241a8e82a0e56567426c8a6c79bb5 Mon Sep 17 00:00:00 2001 From: Josh Meyer Date: Tue, 12 Apr 2022 14:45:35 -0700 Subject: [PATCH] Add Totonac and Chatino from Bulent Ozden --- chatino/bozden/v1.0.0/MODEL_CARD.md | 79 +++++++++++++++++++++++++++++ chatino/bozden/v1.0.0/alphabet.txt | 40 +++++++++++++++ totonac/bozden/v1.0.0/MODEL_CARD.md | 76 +++++++++++++++++++++++++++ totonac/bozden/v1.0.0/alphabet.txt | 39 ++++++++++++++ 4 files changed, 234 insertions(+) create mode 100644 chatino/bozden/v1.0.0/MODEL_CARD.md create mode 100644 chatino/bozden/v1.0.0/alphabet.txt create mode 100644 totonac/bozden/v1.0.0/MODEL_CARD.md create mode 100644 totonac/bozden/v1.0.0/alphabet.txt diff --git a/chatino/bozden/v1.0.0/MODEL_CARD.md b/chatino/bozden/v1.0.0/MODEL_CARD.md new file mode 100644 index 0000000..5f04e2d --- /dev/null +++ b/chatino/bozden/v1.0.0/MODEL_CARD.md @@ -0,0 +1,79 @@ +# Model card for Western Highland Chatino 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 [Bülent Özden](https://twitter.com/bulentozden), a leader of [Common Voice Türkçe](https://twitter.com/CVTurkce). +- Model language: Western Highland Chatino / `ctp` +- Model date: 12th April, 2022 +- Model type: `Speech-to-Text` +- Model version: `v1.0.0` +- Compatible with STT version: `v1.3.0` +- License: CC-BY-SA 4.0 +- 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 [Western Highland Chatino](https://en.wikipedia.org/wiki/https://en.wikipedia.org/wiki/Highland_Chatino) 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 + +|Test Corpus|WER|CER| +|-----------|---|---| +|GORILLA |77.2\%|30.9\%| + +#### Model Size + +`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 [GORILLA `ctp`](https://gorilla.linguistlist.org/code/ctp/) + +### Citation + +* Malgorzata E. Cavar, Damir Cavar, Hilaria Cruz (2016) "Endangered Language Documentation: Bootstrapping a Chatino Speech Corpus, Forced Aligner, ASR". Pages 4004-4011 Of N. Calzolari (et al. eds) *Proceedings of the Tenth International Conference on Language Resources and Evaluation* (LREC 2016) in Portorož, Slovenia, European Language Resources Association (ELRA), Paris, France. + +## Evaluation data + +This model was evaluated on [GORILLA `ctp`](https://gorilla.linguistlist.org/code/ctp/) + +## 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 analyse 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. \ No newline at end of file diff --git a/chatino/bozden/v1.0.0/alphabet.txt b/chatino/bozden/v1.0.0/alphabet.txt new file mode 100644 index 0000000..188c930 --- /dev/null +++ b/chatino/bozden/v1.0.0/alphabet.txt @@ -0,0 +1,40 @@ +# Each line in this file represents the Unicode codepoint (UTF-8 encoded) +# associated with a numeric index. +# A line that starts with # is a comment. You can escape it with \# if you wish +# to use '#' in the Alphabet. + +0 +1 +2 +3 +4 +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 +ñ +õ +ʼ +# The last (non-comment) line needs to end with a newline. diff --git a/totonac/bozden/v1.0.0/MODEL_CARD.md b/totonac/bozden/v1.0.0/MODEL_CARD.md new file mode 100644 index 0000000..932b563 --- /dev/null +++ b/totonac/bozden/v1.0.0/MODEL_CARD.md @@ -0,0 +1,76 @@ +# Model card for Sierra Totonac 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 [Bülent Özden](https://twitter.com/bulentozden), a leader of [Common Voice Türkçe](https://twitter.com/CVTurkce). +- Model language: Totonac / Sierra Totonac / `tos` +- Model date: April 12, 2022 +- Model type: `Speech-to-Text` +- Model version: `v1.0.0` +- Compatible with 🐸 STT version: `v1.3.0` +- License: CC BY-NC-SA 3.0 +- Citation details: `@techreport{totonac-stt, author = {Bülent Özden}, title = {Totonac STT 1.0}, institution = {Coqui}, address = {\url{https://github.com/coqui-ai/STT-models}} year = {2022}, month = {April}, number = {STT-TOS-1.0} }` +- 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 [Sierra Totonac Language](https://en.wikipedia.org/wiki/Sierra_Totonac_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 + +|Test Corpus|WER|CER| +|-----------|---|---| +|OpenSLR 107|87.5\%|25.8\%| + +#### Model Size + +`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 [Totonac Speech with transcription](http://openslr.org/107/) corpus. + +## Evaluation data + +This model was evaluated on [Totonac Speech with transcription](http://openslr.org/107/) corpus. + +## 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. diff --git a/totonac/bozden/v1.0.0/alphabet.txt b/totonac/bozden/v1.0.0/alphabet.txt new file mode 100644 index 0000000..2c1b979 --- /dev/null +++ b/totonac/bozden/v1.0.0/alphabet.txt @@ -0,0 +1,39 @@ +# Each line in this file represents the Unicode codepoint (UTF-8 encoded) +# associated with a numeric index. +# A line that starts with # is a comment. You can escape it with \# if you wish +# to use '#' in the Alphabet. + +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 +á +é +í +ñ +ó +ú +ʼ +# The last (non-comment) line needs to end with a newline.