mwirth7 commited on
Commit
7675857
·
verified ·
1 Parent(s): 13cc4b4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -22
README.md CHANGED
@@ -26,26 +26,6 @@ such as multi-label classification, covariate shift or self-supervised learning.
26
  - **Complementary Code**: [Repository](https://github.com/DBD-research-group/BirdSet)
27
  - **Complementary Paper**: [ArXiv Link](https://arxiv.org/abs/2403.10380)
28
 
29
- ## Update (2024.12.06)
30
- - **This only works for datasets<3.0.0!**
31
- - The [data download size descrepancy](https://github.com/DBD-research-group/BirdSet/issues/267) has been solved.
32
- - TL;DR: During the extraction process, unnecessary archives are now removed immediately. This reduces the required disk space by *half*, now aligning it with the table below.
33
- - Note: If you downloaded the data between this and last update and don't want to update, you can use the following `revision=b0c14a03571a7d73d56b12c4b1db81952c4f7e64`:
34
- ```python
35
- from datasets import load_dataset
36
- ds = load_dataset("DBD-research-group/BirdSet", "HSN", trust_remote_code=True, revision="b0c14a03571a7d73d56b12c4b1db81952c4f7e64")
37
- ```
38
- ## Update (2024.11.27)
39
- - 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.
40
- 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.
41
- - 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:
42
- ```python
43
- from datasets import load_dataset
44
- ds = load_dataset("DBD-research-group/BirdSet", "HSN", trust_remote_code=True, revision="629b54c06874b6d2fa886e1c0d73146c975612d0")
45
- ```
46
-
47
-
48
-
49
  ## Datasets
50
 
51
  **Disclaimer on sizes**: The current dataset sizes reflect the extracted files, as the builder script automatically extracts these files but retains the original zipped versions.
@@ -258,13 +238,39 @@ test = dataset["test_5s"]
258
  'order_multilabel': [5]}}
259
  ```
260
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
261
  ### Citation Information
262
 
263
  ```
264
- @misc{rauch2024birdsetlargescaledatasetaudio,
265
  title={BirdSet: A Large-Scale Dataset for Audio Classification in Avian Bioacoustics},
266
  author={Lukas Rauch and Raphael Schwinger and Moritz Wirth and René Heinrich and Denis Huseljic and Marek Herde and Jonas Lange and Stefan Kahl and Bernhard Sick and Sven Tomforde and Christoph Scholz},
267
- year={2024},
268
  eprint={2403.10380},
269
  archivePrefix={arXiv},
270
  primaryClass={cs.SD},
 
26
  - **Complementary Code**: [Repository](https://github.com/DBD-research-group/BirdSet)
27
  - **Complementary Paper**: [ArXiv Link](https://arxiv.org/abs/2403.10380)
28
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
  ## Datasets
30
 
31
  **Disclaimer on sizes**: The current dataset sizes reflect the extracted files, as the builder script automatically extracts these files but retains the original zipped versions.
 
238
  'order_multilabel': [5]}}
239
  ```
240
 
241
+ ### Changelog
242
+
243
+ ## 2025.09.10
244
+ - Updated dataset description and citation in BirdSet.py
245
+ - Now works with datasets<4.0.0
246
+ - `load_dataset(..., cache_dir="/path/to/custom/cache")` almost works like in previous datasets<3.0.0 version.
247
+ With the different that archive files are downloaded to `HF_HOME/HF_DATASETS` environment variable path but extracted file are save in cache_dir if specified.
248
+ During extraction archive files are still deleted during extraction, see previous update/issue, to save disk space.
249
+
250
+ ## 2024.12.06
251
+ - The [data download size descrepancy](https://github.com/DBD-research-group/BirdSet/issues/267) has been solved.
252
+ - TL;DR: During the extraction process, unnecessary archives are now removed immediately. This reduces the required disk space by *half*, now aligning it with the table below.
253
+ - Note: If you downloaded the data between this and last update and don't want to update, you can use the following `revision=b0c14a03571a7d73d56b12c4b1db81952c4f7e64`:
254
+ ```python
255
+ from datasets import load_dataset
256
+ ds = load_dataset("DBD-research-group/BirdSet", "HSN", trust_remote_code=True, revision="b0c14a03571a7d73d56b12c4b1db81952c4f7e64")
257
+ ```
258
+ ## 2024.11.27
259
+ - 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.
260
+ 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.
261
+ - 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:
262
+ ```python
263
+ from datasets import load_dataset
264
+ ds = load_dataset("DBD-research-group/BirdSet", "HSN", trust_remote_code=True, revision="629b54c06874b6d2fa886e1c0d73146c975612d0")
265
+ ```
266
+
267
  ### Citation Information
268
 
269
  ```
270
+ @misc{rauch2025birdsetlargescaledatasetaudio,
271
  title={BirdSet: A Large-Scale Dataset for Audio Classification in Avian Bioacoustics},
272
  author={Lukas Rauch and Raphael Schwinger and Moritz Wirth and René Heinrich and Denis Huseljic and Marek Herde and Jonas Lange and Stefan Kahl and Bernhard Sick and Sven Tomforde and Christoph Scholz},
273
+ year={2025},
274
  eprint={2403.10380},
275
  archivePrefix={arXiv},
276
  primaryClass={cs.SD},