Update README.md

README.md

@@ -15,25 +15,36 @@ should probably proofread and complete it, then remove this comment. -->
 
 # hubert-finetuned-animals
 
-This model is a fine-tuned version of [facebook/hubert-base-ls960](https://huggingface.co/facebook/hubert-base-ls960) on the None dataset.
+This model, `hubert-finetuned-animals`, is a fine-tuned version of `facebook/hubert-base-ls960` specifically for the task of animal sound classification. The model has been trained to identify various animal sounds from a subset of the ESC-50 dataset, focusing exclusively on animal categories.
 It achieves the following results on the evaluation set:
 - Loss: 0.5596
 - Accuracy: 0.95
 
 ## Model description
 
-More information needed
+The HuBERT model, originally trained on large amounts of unlabelled audio data, has been fine-tuned here for a downstream task of animal sound classification. This fine-tuning allows the model to specialize in recognizing distinct animal sounds, such as those of dogs, cats, birds, etc., which can be particularly useful in applications such as bioacoustic monitoring, educational tools, and more interactive forms of wildlife conservation efforts.
 
 ## Intended uses & limitations
 
-More information needed
+This model is intended for the classification of specific animal sounds within audio clips. It can be used in software applications related to wildlife research, educational content related to animals, or for entertainment purposes where animal sound recognition is needed.
+
+### Limitations
+
+While the model shows high accuracy, it is trained on a limited set of categories from the ESC-50 dataset, which may not cover all possible animal sounds. The performance can vary significantly with audio quality, background noise, and animal sound variations not represented in the training data.
 
 ## Training and evaluation data
 
-More information needed
+The model was fine-tuned on a subset of the ESC-50 dataset, which is a publicly available collection designed for environmental sound classification tasks. This subset specifically includes only the categories relevant to animal sounds. Each category in the dataset contains 40 examples, providing a diverse set of samples for model training and evaluation.
 
 ## Training procedure
 
+The model was fine-tuned using the following procedure:
+
+1. Preprocessing: Audio files were converted into spectrograms.
+2. Data Split: The data was split into 70% training, 20% testing sets and 10% validation sets.
+3. Fine-tuning: The model was fine-tuned for 10 epochs on the training set.
+4. Evaluation: The model's performance was evaluated on the validation set after each epoch to monitor improvement and prevent overfitting.
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
@@ -68,3 +79,7 @@ The following hyperparameters were used during training:
 - Pytorch 2.0.1+cu118
 - Datasets 2.14.5
 - Tokenizers 0.13.3
+
+### Github Repository
+
+[Animal Sound Classification](https://github.com/rawbeen248/audio_classification_finetuning)