Mod: Update evrsion to 0.5.2 and doc pages.

Labbeti · Mar 23, 2024 · 6733609 · 6733609
1 parent a0653fa
commit 6733609
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.5.2] UNRELEASED
+## [0.5.2] 2024-03-23
 ### Added
 - `freesound_no_clotho_v2` subset to WavCaps to avoid all bias with Clotho test and analysis subsets.
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -22,5 +22,5 @@ keywords:
   - captioning
   - audio-captioning
 license: MIT
-version: 0.5.1
-date-released: '2024-03-04'
+version: 0.5.2
+date-released: '2024-03-23'
diff --git a/README.md b/README.md
@@ -74,14 +74,14 @@ aac-datasets-download --root "." clotho --subsets "dev"
 | Subsets | `train`, `val`, `test` | `dev`, `val`, `eval`, `dcase_aac_test`, `dcase_aac_analysis`, `dcase_t2a_audio`, `dcase_t2a_captions` | `full` | `as`, `as_noac`, `bbc`, `fsd`, `fsd_nocl`, `sb` |
 | Sample rate (kHz) | 32 | 44.1 | 48 | 32 |
 | Estimated size (GB) | 43 | 53 | 13 | 941 |
-| Audio source | AudioSet | FreeSound | TAU Urban Acoustic Scenes 2019 | AudioSet, BBC Sound Effects, FreeSound, SoundBible | -->
+| Audio source | AudioSet | Freesound | TAU Urban Acoustic Scenes 2019 | AudioSet, BBC Sound Effects, Freesound, SoundBible | -->
 
 | Dataset | Sampling<br>rate (kHz) | Estimated<br>size (GB) | Source | Subsets |
 |:---:|:---:|:---:|:---:|:---:|
 | AudioCaps | 32 | 43 | AudioSet | `train`<br>`val`<br>`test`<br>`train_v2` |
 | Clotho | 44.1 | 53  | Freesound | `dev`<br>`val`<br>`eval`<br>`dcase_aac_test`<br>`dcase_aac_analysis`<br>`dcase_t2a_audio`<br>`dcase_t2a_captions` |
 | MACS | 48 | 13 | TAU Urban Acoustic Scenes 2019 | `full` |
-| WavCaps | 32 | 941 | AudioSet<br>BBC Sound Effects<br>FreeSound<br>SoundBible | `as`<br>`as_noac`<br>`bbc`<br>`fsd`<br>`fsd_nocl`<br>`sb` |
+| WavCaps | 32 | 941 | AudioSet<br>BBC Sound Effects<br>Freesound<br>SoundBible | `audioset`<br>`audioset_no_audiocaps`<br>`bbc`<br>`freesound`<br>`freesound_no_clotho`<br>`freesound_no_clotho_v2`<br>`soundbible` |
 
 For Clotho, the **dev** subset should be used for training, val for validation and eval for testing.
 
@@ -182,7 +182,7 @@ If you use this software, please consider cite it as "Labbe, E. (2013). aac-data
     month = {03},
     title = {{aac-datasets}},
     url = {https://github.com/Labbeti/aac-datasets/},
-    version = {0.5.1},
+    version = {0.5.2},
     year = {2024}
 }
 ```

diff --git a/docs/aac_datasets.utils.rst b/docs/aac_datasets.utils.rst
@@ -18,3 +18,4 @@ Submodules
    aac_datasets.utils.collections
    aac_datasets.utils.download
    aac_datasets.utils.globals
+   aac_datasets.utils.type_checks
diff --git a/docs/aac_datasets.utils.type_checks.rst b/docs/aac_datasets.utils.type_checks.rst
@@ -0,0 +1,7 @@
+aac\_datasets.utils.type\_checks module
+=======================================
+
+.. automodule:: aac_datasets.utils.type_checks
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/src/aac_datasets/__init__.py b/src/aac_datasets/__init__.py
@@ -12,7 +12,7 @@
 __maintainer__ = "Étienne Labbé (Labbeti)"
 __name__ = "aac-datasets"
 __status__ = "Development"
-__version__ = "0.5.1"
+__version__ = "0.5.2"
 
 
 from .datasets.audiocaps import AudioCaps