Updates README

README.md

@@ -12,31 +12,48 @@ model-index:
   results: []
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# mms-common_voice_13_0-eo-1, an Esperanto speech recognizer
 
-# mms-common_voice_13_0-eo-1
-
-This model is a fine-tuned version of [patrickvonplaten/mms-300m](https://huggingface.co/patrickvonplaten/mms-300m) on the MOZILLA-FOUNDATION/COMMON_VOICE_13_0 - EO dataset.
+This model is a fine-tuned version of [patrickvonplaten/mms-300m](https://huggingface.co/patrickvonplaten/mms-300m) on the the [mozilla-foundation/common_voice_13_0](https://huggingface.co/datasets/mozilla-foundation/common_voice_13_0) Esperanto dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.2257
 - Cer: 0.0209
 - Wer: 0.0678
 
+While the training loss is lower, this model does not perform significantly better than [xekri/wav2vec2-common_voice_13_0-eo-3](https://huggingface.co/xekri/wav2vec2-common_voice_13_0-eo-3).
+
+The first 10 samples in the test set:
+
+| Actual | CER |
+| Predicted |  |
+|:---------:|:---:|
+| `la orienta parto apud benino kaj niĝerio estis nomita sklavmarbordo`<br>`la orienta parto apud benino kaj niĝerio estis nomita sklavmarbordo` | 0.0 |
+| `en la sekva jaro li ricevis premion`<br>`en la sekva jaro li ricevis premion` | 0.0 |
+| `ŝi studis historion ĉe la universitato de brita kolumbio`<br>`ŝi studis historion ĉe la universitato de brita kolumbio` | 0.0 |
+| `larĝaj ŝtupoj kuras al la fasado`<br>`larĝaj ŝtupoj kuras al la fasado` | 0.0 |
+| `la municipo ĝuas duan epokon de etendo kaj disvolviĝo`<br>`la municipo ĝuas duan epokon de etendo kaj disvolviĝo` | 0.0 |
+| `li estis ankaŭ katedrestro kaj dekano`<br>`li estis ankaŭ katedresto kaj dekano` | 0.02702702702702703 |
+| `librovendejo apartenas al la muzeo`<br>`librovendejo apartenas al la muzeo` | 0.0 |
+| `ĝi estas kutime malfacile videbla kaj troviĝas en subkreskaĵaro de arbaroj`<br>`ĝi estas kutime malfacile videbla kaj troviĝas en subkreskaĵo de arbaroj` | 0.02702702702702703 |
+| `unue ili estas ruĝaj poste brunaj`<br>`unue ili estas ruĝaj poste brunaj` | 0.0 |
+| `la loĝantaro laboras en la proksima ĉefurbo`<br>`la loĝantaro laboras en la proksima ĉefurbo` | 0.0 |
+
 ## Model description
 
-More information needed
+See [patrickvonplaten/mms-300m](https://huggingface.co/patrickvonplaten/mms-300m), or equivalently, [facebook/wav2vec2-large-xlsr-53](https://huggingface.co/facebook/wav2vec2-large-xlsr-53), as it seems to me that the only difference is that the speech front-end was trained with more languages and data in the mms-300m checkpoint.
 
 ## Intended uses & limitations
 
-More information needed
+Speech recognition for Esperanto. The base model was pretrained and finetuned on 16kHz sampled speech audio. When using the model make sure that your speech input is also sampled at 16KHz.
 
 ## Training and evaluation data
 
-More information needed
+The training split was set to `train[:15000]` while the eval split was set to `validation[:1500]`.
 
 ## Training procedure
 
+The same as [xekri/wav2vec2-common_voice_13_0-eo-3](https://huggingface.co/xekri/wav2vec2-common_voice_13_0-eo-3).
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
@@ -47,6 +64,7 @@ The following hyperparameters were used during training:
 - gradient_accumulation_steps: 4
 - total_train_batch_size: 32
 - optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- layerdrop: 0.1
 - lr_scheduler_type: linear
 - lr_scheduler_warmup_steps: 500
 - num_epochs: 100