Update README.md

README.md

@@ -1,3 +1,40 @@
----
-license: mit
----
+---
+license: cc-by-4.0
+---
+
+# ABGS Ecoacoustic Tagging Model
+Model that tags audio files as belonging to one or more of the following labels: anthropophony (A), biophony (B), geophony (G), or silence (S).
+
+## Installation
+To use the model, you have to install autrainer, e.g. via pip:
+
+```bash
+pip install autrainer
+```
+
+## Usage
+The model can be applied on all wav files present in a folder (<data-root>) and stored in another folder (<output-root>):
+
+```python
+autrainer inference hf:autrainer/edansa-2019-cnn10-32k-t <data-root> <output-root>
+```
+
+## Training
+
+### Pretraining
+The model has been originally trained on AudioSet by Kong et. al..
+
+### Dataset
+The model has been further trained (finetuned) on the training set of the EDANSA2019 dataset. The dataset was collected in the North Slope of Alaskan at latitudes between 64◦ and 70◦ N, and longitudes between 139◦ to 150◦ W from a total of 40 devices, each placed in a different location, separated by ca. 20kM from other locations. A subset of the entire dataset has been annotated for 28 labels (tags), of which only the 4 highest level categories were used: anthropophony, biophony, geophony, and silence. The sampling rate was 48kHz.
+
+### Features
+The EDANSA2019 dataset was resampled to 32kHz, as this was the sampling rate of AudioSet, where the model was originally trained on. Log mel spectrograms were then extracted using torchlibrosa using the parameters that the upstream model was trained on.
+
+### Training process
+The model has been trained for 30 epochs. At the end of each epoch, the model was evaluated on the official validation set. We release the state that achieved the best performance on this validation set.
+
+### Evaluation
+The model has only been evaluated on in-domain data. The performance on the official test set reached a 0.9 (weighted) f1-score.
+
+## Acknowledgments
+Please acknowledge the work which produced the original model and the EDANSA2019 dataset. We would also appreciate an acknowledgment to autrainer.