Skip to content

Commit

Permalink
Mod: Update README table datasets.
Browse files Browse the repository at this point in the history
  • Loading branch information
Labbeti committed Dec 7, 2023
1 parent 36a865b commit 6f54217
Showing 1 changed file with 24 additions and 17 deletions.
41 changes: 24 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,36 @@ for batch in dataloader:
...
```

## Datasets stats
## Download datasets
To download a dataset, you can use `download` argument in dataset construction :
```python
dataset = Clotho(root=".", subset="dev", download=True)
```
However, if you want to download datasets from a script, you can also use the following command :
```bash
aac-datasets-download --root "." clotho --subsets "dev"
```

## Datasets information
Here is the statistics for each dataset :

| | AudioCaps | Clotho | MACS | WavCaps |
<!-- | | AudioCaps | Clotho | MACS | WavCaps |
|:---:|:---:|:---:|:---:|:---:|
| 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 |
| 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`
| 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` |

For Clotho, the dev subset should be used for training, val for validation and eval for testing.
For Clotho, the **dev** subset should be used for training, val for validation and eval for testing.

Here is the **train** subset statistics for AudioCaps, Clotho and MACS datasets :
Here is additional statistics on the train subset for AudioCaps, Clotho and MACS:

| | AudioCaps/train | Clotho/dev | MACS/full |
|:---:|:---:|:---:|:---:|
Expand All @@ -86,7 +103,7 @@ Here is the **train** subset statistics for AudioCaps, Clotho and MACS datasets

## Requirements

This package has been developped for Ubuntu 20.04, and it is expected to work on most Linux distributions.
This package has been developped for Ubuntu 20.04, and it is expected to work on most Linux-based distributions.
### Python packages

Python requirements are automatically installed when using pip on this repository.
Expand Down Expand Up @@ -116,16 +133,6 @@ dataset = AudioCaps(
)
```

## Download datasets
To download a dataset, you can use `download` argument in dataset construction :
```python
dataset = Clotho(root=".", subset="dev", download=True)
```
However, if you want to download datasets from a script, you can also use the following command :
```bash
aac-datasets-download --root "." clotho --subsets "dev"
```

## Additional information
### Compatibility with audiocaps-download
If you want to use [audiocaps-download 1.0](https://github.com/MorenoLaQuatra/audiocaps-download) package to download AudioCaps, you will have to respect the AudioCaps folder tree:
Expand Down

0 comments on commit 6f54217

Please sign in to comment.