Update README.md

README.md

@@ -1,64 +1,71 @@
 ---
+language: en
 license: apache-2.0
 tags:
-- generated_from_trainer
+  - audio-classification
+  - generated_from_trainer
 metrics:
-- accuracy
-- f1
+  - accuracy
+  - f1
 model-index:
-- name: distil-wav2vec2-adult-child-cls-v3
-  results: []
+  - name: distil-wav2vec2-adult-child-cls-v3
+    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. -->
+# DistilWav2Vec2 Adult/Child Speech Classifier
 
-# distil-wav2vec2-adult-child-cls-v3
+DistilWav2Vec2 Adult/Child Speech Classifier is an audio classification model based on the [wav2vec 2.0](https://arxiv.org/abs/2006.11477) architecture. This model is a distilled version of [wav2vec2-adult-child-cls-v3](https://huggingface.co/w11wo/wav2vec2-adult-child-cls-v3) on a private adult/child speech classification dataset.
 
-This model is a fine-tuned version of [w11wo/wav2vec2-adult-child-cls-v3](https://huggingface.co/w11wo/wav2vec2-adult-child-cls-v3) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.1301
-- Accuracy: 0.9603
-- F1: 0.9639
+This model was trained using HuggingFace's PyTorch framework. All training was done on a Tesla P100, provided by Kaggle. [Training metrics](https://huggingface.co/w11wo/wav2vec2-adult-child-cls-v3/tensorboard) were logged via Tensorboard.
 
-## Model description
+## Model
 
-More information needed
+| Model                                | #params | Arch.       | Training/Validation data (text)           |
+| ------------------------------------ | ------- | ----------- | ----------------------------------------- |
+| `distil-wav2vec2-adult-child-cls-v3` | 52M     | wav2vec 2.0 | Adult/Child 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 Speech Classification | 0.1301 | 96.03%   | 0.9639 |
 
 ## Training procedure
 
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
-- learning_rate: 3e-05
-- train_batch_size: 32
-- eval_batch_size: 32
-- seed: 42
-- gradient_accumulation_steps: 4
-- total_train_batch_size: 128
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: linear
-- lr_scheduler_warmup_ratio: 0.1
-- num_epochs: 3
+
+- `learning_rate`: 3e-05
+- `train_batch_size`: 32
+- `eval_batch_size`: 32
+- `seed`: 42
+- `gradient_accumulation_steps`: 4
+- `total_train_batch_size`: 128
+- `optimizer`: Adam with `betas=(0.9,0.999)` and `epsilon=1e-08`
+- `lr_scheduler_type`: linear
+- `lr_scheduler_warmup_ratio`: 0.1
+- `num_epochs`: 3
 
 ### Training results
 
-| Training Loss | Epoch | Step | Validation Loss | Accuracy | F1     |
-|:-------------:|:-----:|:----:|:---------------:|:--------:|:------:|
-| 0.212         | 1.0   | 96   | 0.1561          | 0.9561   | 0.9596 |
-| 0.1523        | 2.0   | 192  | 0.1408          | 0.9575   | 0.9616 |
-| 0.0844        | 3.0   | 288  | 0.1301          | 0.9603   | 0.9639 |
+| Training Loss | Epoch | Step | Validation Loss | Accuracy |   F1   |
+| :-----------: | :---: | :--: | :-------------: | :------: | :----: |
+|     0.212     |  1.0  |  96  |     0.1561      |  0.9561  | 0.9596 |
+|    0.1523     |  2.0  | 192  |     0.1408      |  0.9575  | 0.9616 |
+|    0.0844     |  3.0  | 288  |     0.1301      |  0.9603  | 0.9639 |
+
+## Disclaimer
+
+Do consider the biases which came from pre-training datasets that may be carried over into the results of this model.
+
+## Authors
 
+DistilWav2Vec2 Adult/Child Speech Classifier was trained and evaluated by [Wilson Wongso](https://w11wo.github.io/). All computation and development are done on Kaggle.
 
-### Framework versions
+## Framework versions
 
 - Transformers 4.16.2
 - Pytorch 1.10.2+cu102