Update README.md

README.md

@@ -26,6 +26,16 @@ such as multi-label classification, covariate shift or self-supervised learning.
 - **Complementary Code**: [Repository](https://github.com/DBD-research-group/BirdSet)
 - **Complementary Paper**: [ArXiv Link](https://arxiv.org/abs/2403.10380)
 
+## Update (2024.11.27)
+- Additional bird taxonomy metadata, including "Genus," "Species Group," and "Order," is provided using the 2021 eBird taxonomy, consistent with the taxonomy used for the 'ebird_code' data. 
+  These metadata fields follow the same format and encoding as 'ebird_code' and 'ebird_code_multilabel'. See below for an updated explanation of the metadata.
+- If you don't require the additional taxonomy at the moment and prefer to avoid re-downloading all files, you can specify the previous revision directly in load_dataset as follows:
+```python
+from datasets import load_dataset
+ds = load_dataset("DBD-research-group/BirdSet", "HSN", trust_remote_code=True, revision="629b54c06874b6d2fa886e1c0d73146c975612d0")
+```
+
+
 
 ## Datasets
 
@@ -149,6 +159,12 @@ test = dataset["test_5s"]
 | peaks                  |  Sequence(datasets.Value("float64"))                   | only traindata: peak event detected with scipy peak detection                        |     
 | quality                |  Value("string")                                       | only traindata: recording quality of the recording (A,B,C)                        |     
 | recordist              |  Value("string")                                       | only traindata: recordist of the recording                        |   
+| genus                  |  ClassLabel(names=class_list)                          | species genus label                        |   
+| species_group          |  ClassLabel(names=class_list)                          | species species_group label                        |   
+| order                  |  ClassLabel(names=class_list)                          | species order label                        |   
+| genus_multilabel       |  Sequence(datasets.ClassLabel(names=class_list))       | species genus label in a multilabel format                        |   
+| species_group_multilabel|  Sequence(datasets.ClassLabel(names=class_list))      | species species_group label in a multilabel format                        |   
+| order_multilabel       |  Sequence(datasets.ClassLabel(names=class_list))       | species order label in a multilabel format                        |   
 
 #### Example Metadata Train
 
@@ -187,7 +203,13 @@ test = dataset["test_5s"]
  'event_cluster': [0, 0, 0, 0, 0, -1, 0, 0, -1, 0],
  'peaks': [14.76479119037789, 41.16993396760847],
  'quality': 'A',
- 'recordist': '...'}
+ 'recordist': '...'
+ 'genus': 26,
+ 'species_group': 7,
+ 'order': 5,
+ 'genus_multilabel': None,
+ 'species_group_multilabel': None,
+ 'order_multilabel': None}}
 ```
 
 #### Example Metadata Test5s
@@ -218,7 +240,13 @@ test = dataset["test_5s"]
  'event_cluster': None,
  'peaks': None,
  'quality': None,
- 'recordist': None}
+ 'recordist': None,
+ 'genus': None,
+ 'species_group': None,
+ 'order': None,
+ 'genus_multilabel': [26],
+ 'species_group_multilabel': [7],
+ 'order_multilabel': [5]}}
 ```
 
 ### Citation Information