Update README.md

README.md

@@ -1,67 +1,74 @@
 ---
+language: id
 license: apache-2.0
 tags:
-- generated_from_trainer
+    - audio-classification
+    - generated_from_trainer
 metrics:
-- accuracy
-- f1
+    - accuracy
+    - f1
 model-index:
-- name: wav2vec2-xls-r-300m-adult-child-id-cls
-  results: []
+    - name: wav2vec2-xls-r-adult-child-id-cls
+      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. -->
+# Wav2Vec2 XLS-R Adult/Child Indonesian Speech Classifier
 
-# wav2vec2-xls-r-300m-adult-child-id-cls
+Wav2Vec2 XLS-R Adult/Child Indonesian Speech Classifier is an audio classification model based on the [XLS-R](https://arxiv.org/abs/2111.09296) architecture. This model is a fine-tuned version of [wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on a private adult/child Indonesian speech classification dataset.
 
-This model is a fine-tuned version of [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.1970
-- Accuracy: 0.9338
-- F1: 0.9307
+This model was trained using HuggingFace's PyTorch framework. All training was done on a Tesla P100, provided by Kaggle. Training metrics were logged via Tensorboard.
 
-## Model description
+## Model
 
-More information needed
+| Model                               | #params | Arch. | Training/Validation data (text)                      |
+| ----------------------------------- | ------- | ----- | ---------------------------------------------------- |
+| `wav2vec2-xls-r-adult-child-id-cls` | 300M    | XLS-R | Adult/Child Indonesian Speech Classification Dataset |
 
-## Intended uses & limitations
+## Evaluation Results
 
-More information needed
+The model achieves the following results on evaluation:
 
-## Training and evaluation data
-
-More information needed
+| Dataset                                      | Loss   | Accuracy | F1     |
+| -------------------------------------------- | ------ | -------- | ------ |
+| Adult/Child Indonesian Speech Classification | 0.1970 | 93.38%   | 0.9307 |
 
 ## Training procedure
 
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
-- learning_rate: 3e-05
-- train_batch_size: 8
-- eval_batch_size: 8
-- seed: 42
-- gradient_accumulation_steps: 4
-- total_train_batch_size: 32
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: linear
-- lr_scheduler_warmup_ratio: 0.1
-- num_epochs: 4
+
+-   `learning_rate`: 3e-05
+-   `train_batch_size`: 8
+-   `eval_batch_size`: 8
+-   `seed`: 42
+-   `gradient_accumulation_steps`: 4
+-   `total_train_batch_size`: 32
+-   `optimizer`: Adam with `betas=(0.9,0.999)` and `epsilon=1e-08`
+-   `lr_scheduler_type`: linear
+-   `lr_scheduler_warmup_ratio`: 0.1
+-   `num_epochs`: 4
 
 ### Training results
 
-| Training Loss | Epoch | Step | Validation Loss | Accuracy | F1     |
-|:-------------:|:-----:|:----:|:---------------:|:--------:|:------:|
-| 0.336         | 1.0   | 305  | 0.3146          | 0.8845   | 0.8698 |
-| 0.2345        | 2.0   | 610  | 0.2140          | 0.9251   | 0.9202 |
-| 0.3215        | 3.0   | 915  | 0.2038          | 0.9315   | 0.9286 |
-| 0.2059        | 4.0   | 1220 | 0.1970          | 0.9338   | 0.9307 |
+| Training Loss | Epoch | Step | Validation Loss | Accuracy |   F1   |
+| :-----------: | :---: | :--: | :-------------: | :------: | :----: |
+|     0.336     |  1.0  | 305  |     0.3146      |  0.8845  | 0.8698 |
+|    0.2345     |  2.0  | 610  |     0.2140      |  0.9251  | 0.9202 |
+|    0.3215     |  3.0  | 915  |     0.2038      |  0.9315  | 0.9286 |
+|    0.2059     |  4.0  | 1220 |     0.1970      |  0.9338  | 0.9307 |
+
+## Disclaimer
+
+Do consider the biases which came from pre-training datasets that may be carried over into the results of this model.
+
+## Authors
 
+Wav2Vec2 XLS-R Adult/Child Indonesian Speech Classifier was trained and evaluated by [Ananto Joyoadikusumo](https://anantoj.github.io/). All computation and development are done on Kaggle.
 
-### Framework versions
+## Framework versions
 
-- Transformers 4.18.0
-- Pytorch 1.11.0+cu102
-- Datasets 2.2.0
-- Tokenizers 0.12.1
+-   Transformers 4.18.0
+-   Pytorch 1.11.0+cu102
+-   Datasets 2.2.0
+-   Tokenizers 0.12.1