Create README.md

README.md

@@ -0,0 +1,155 @@
+---
+task_categories:
+- audio-classification
+---
+
+
+### Datasets
+    
+#### Train
+- Exclusively using focal audio data from Xeno-Canto (XC) with quality ratings A, B, C and excluding all recordings that are CC-ND.
+- Each dataset is tailored for specific target species identified in soundscape files.
+- We offer detected events and corresponding cluster assignments to identify bird sounds in each recording.
+- We provide the full recordings from XC! These can generate multiple samples from a single instance.
+
+#### Test
+- Only soundscape data sourced from Zenodo.
+- We provide the full recording with the complete label set and specified bounding boxes.
+- This dataset excludes recordings that do not contain bird calls ("no_call").
+- Task: Multiclass ("ebird_code")
+
+#### Test_5s
+- Only soundscape data from Zenodo formatted acoording to the Kaggle evaluation scheme.
+- Each recording is segmented into 5-second intervals without overlaps.
+- This contains the "no_call" class.
+- Task: Multilabel ("ebird_code_multilabel")
+
+### Subsets
+
+Numbers need to be updated
+
+|                            | train   |    test    | test_5s |  size (GB) |   #classes   |
+|----------------------------|--------:|-----------:|--------:|-----------:|-------------:|
+| PER (amazon_basin)         |  21,834 |     14,798 |  15,120 |   13       |     132      |
+| NES (columbia_costa_rica)  |  4,650  |     6,952  |  24,480 |   17       |      89      |
+| UHH (hawaiian_islands)     |  4,611  |     59,583 |  36,637 |   6.3      | 25 tr, 27 te |
+| HSN (high_sierras)         |  6,526  |     10,296 |  12,000 |   6.9      |      21      |
+| NBP (nips)                 |  100,174|      5,493 |     563 |   162      |  51 tr, 52 te|
+| POW (powdermill_nature)    |  17,059 |     16,052 |     4560|   18       |      48      |
+| SSW (sapsucker_woods)      |  32,902 |     50,760 |  205,200|   40       |      81      |
+| SNE (sierra_nevada)        |  23,164 |     20,147 |   23,756|   25       |      56      |
+| XCL (xenocanto)            |  686,593|       x    |         |   648      |   10,124     |
+| XCM                        |  80,012 |       x    |         |            |    410       |
+
+#### FEATURES
+
+```python
+{
+  "audio": datasets.Audio(sampling_rate=32_000, mono=True, decode=True),
+  "filepath": datasets.Value("string"),
+  "start_time": datasets.Value("float64"),
+  "end_time": datasets.Value("float64"),
+  "low_freq": datasets.Value("int64"),
+  "high_freq": datasets.Value("int64"),
+  "ebird_code": datasets.ClassLabel(names=class_list),
+  "ebird_code_multilabel": datasets.Sequence(datasets.ClassLabel(names=["no_call"] + class_list)),
+  "ebird_code_secondary": datasets.Sequence(datasets.Value("string")),
+  "call_type": datasets.Value("string"),
+  "sex": datasets.Value("string"),
+  "lat": datasets.Value("float64"),
+  "long": datasets.Value("float64"),
+  "length": datasets.Value("int64"),
+  "microphone": datasets.Value("string"),
+  "license": datasets.Value("string"),
+  "source": datasets.Value("string"),
+  "local_time": datasets.Value("string"),
+  "detected_events": datasets.Sequence(datasets.Sequence(datasets.Value("float64"))),
+  "event_cluster": datasets.Sequence(datasets.Value("int64")),
+  "quality": datasets.Value("string"),
+  "recordist": datasets.Value("string")
+        })
+```
+```python
+EXAMPLE TRAIN
+{'audio': {'path': '.ogg',
+  'array': array([ 6.24680333e-02,  7.57145062e-02,  4.91199419e-02, ...,
+         -2.04162002e-02,  8.73558223e-03, -6.23320229e-05]),
+  'sampling_rate': 32000},
+ 'filepath': '.ogg',
+ 'start_time': None,
+ 'end_time': None,
+ 'low_freq': None,
+ 'high_freq': None,
+ 'ebird_code': 1,
+ 'ebird_code_multiclass': None,
+ 'call_type': 'call',
+ 'sex': None,
+ 'lat': 22.2029,
+ 'long': -159.473,
+ 'microphone': 'focal',
+ 'license': '//creativecommons.org/licenses/by-nc-sa/4.0/',
+ 'source': 'xenocanto',
+ 'local_time': '12:49',
+ 'detected_events': [[0.832, 2.48],
+  [2.992, 4.016],
+  [3.2, 3.904],
+  [5.472, 6.048],
+  [5.488, 6.432],
+  [7.088, 8.16],
+  [8.944, 10.432],
+  [10.72, 12.672],
+  [11.152, 13.2],
+  [13.488, 14.0],
+  [14.64, 16.496]],
+ 'event_cluster': [1, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1],
+ 'quality': 'A'}
+
+EXAMPLE TEST_5S
+{'audio': {'path': '.ogg',
+  'array': array([-5.03219722e-04,  9.99580720e-04,  2.58744985e-05, ...,
+         -4.06746846e-03, -3.79991997e-03,  2.88472045e-04]),
+  'sampling_rate': 32000},
+ 'filepath': '.ogg',
+ 'start_time': 0.0,
+ 'end_time': 5.0,
+ 'low_freq': 2678,
+ 'high_freq': 6053,
+ 'ebird_code': None,
+ 'ebird_code_multiclass': [0],
+ 'call_type': None,
+ 'sex': None,
+ 'lat': 19.801668,
+ 'long': -155.609444,
+ 'microphone': 'Soundscape',
+ 'license': 'Creative Commons Attribution 4.0 International Public License',
+ 'source': 'https://zenodo.org/record/7078499',
+ 'local_time': '15:00:06',
+ 'detected_events': None,
+ 'event_cluster': None,
+ 'quality': None}
+
+EXAMPLE TEST
+{'audio': {'path': '.ogg',
+  'array': array([-5.03219722e-04,  9.99580720e-04,  2.58744985e-05, ...,
+         -4.06746846e-03, -3.79991997e-03,  2.88472045e-04]),
+  'sampling_rate': 32000},
+ 'filepath': '.ogg',
+ 'start_time': 6.8,
+ 'end_time': 8.2,
+ 'low_freq': 2678,
+ 'high_freq': 6053,
+ 'ebird_code': 22,
+ 'ebird_code_multiclass': None,
+ 'call_type': None,
+ 'sex': None,
+ 'lat': 19.801668,
+ 'long': -155.609444,
+ 'microphone': 'Soundscape',
+ 'license': 'Creative Commons Attribution 4.0 International Public License',
+ 'source': 'https://zenodo.org/record/7078499',
+ 'local_time': '15:00:06',
+ 'detected_events': None,
+ 'event_cluster': None,
+ 'quality': None}
+```
+