Improve dataset card: Add task category, abstract summary, links, and sample usage
Browse filesThis PR significantly enhances the dataset card for the Differentiable Vocal Effects Presets Dataset by:
- Adding `audio-to-audio` to the `task_categories` and `vocal-effects` to the `tags` metadata for improved discoverability.
- Incorporating a summary of the paper's abstract to provide better context for the dataset.
- Consolidating relevant links (Paper, Code, Demo) into a dedicated "Links" section for easier navigation.
- Including a "Sample Usage" section with a quick start guide extracted from the GitHub repository, enabling users to more easily get started with the dataset.
README.md
CHANGED
|
@@ -1,17 +1,45 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
-
tags:
|
| 4 |
-
- music
|
| 5 |
size_categories:
|
| 6 |
- n<1K
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
viewer: false
|
| 8 |
---
|
| 9 |
|
| 10 |
# Differentiable Vocal Effects Presets Dataset
|
| 11 |
|
| 12 |
-
This dataset is
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
|
| 14 |
The preset datasets, **Internal** and **MedleyDB**, are stored in the folder [`presets`](presets/).
|
| 15 |
Please check the original repository for more details on the individual files.
|
| 16 |
The [modules/](modules/) contains differentiable effects implemented in PyTorch for loading the presets and applying them to audio data.
|
| 17 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
| 3 |
size_categories:
|
| 4 |
- n<1K
|
| 5 |
+
tags:
|
| 6 |
+
- music
|
| 7 |
+
- vocal-effects
|
| 8 |
+
task_categories:
|
| 9 |
+
- audio-to-audio
|
| 10 |
viewer: false
|
| 11 |
---
|
| 12 |
|
| 13 |
# Differentiable Vocal Effects Presets Dataset
|
| 14 |
|
| 15 |
+
This dataset is associated with DiffVox, a novel and interpretable model designed for matching vocal effects in music production. DiffVox integrates parametric equalisation, dynamic range control, delay, and reverb using efficient differentiable implementations, enabling gradient-based optimisation for parameter estimation. The vocal presets contained within this dataset were retrieved from two collections: 70 tracks from MedleyDB and 365 tracks from a private collection. This work lays the foundation for future research in vocal effects modelling and automatic mixing.
|
| 16 |
+
|
| 17 |
+
This dataset is a clone of a subset of the [diffvox](https://github.com/SonyResearch/diffvox/) repository, containing a collection of vocal effect presets derived from a proprietary multitrack dataset.
|
| 18 |
+
|
| 19 |
+
## Links
|
| 20 |
+
- Paper: [DiffVox: A Differentiable Model for Capturing and Analysing Vocal Effects Distributions](https://arxiv.org/abs/2504.14735)
|
| 21 |
+
- Code: [https://github.com/SonyResearch/diffvox](https://github.com/SonyResearch/diffvox)
|
| 22 |
+
- Demo Space: [https://huggingface.co/spaces/yoyolicoris/diffvox](https://huggingface.co/spaces/yoyolicoris/diffvox)
|
| 23 |
+
|
| 24 |
+
## Dataset Structure
|
| 25 |
|
| 26 |
The preset datasets, **Internal** and **MedleyDB**, are stored in the folder [`presets`](presets/).
|
| 27 |
Please check the original repository for more details on the individual files.
|
| 28 |
The [modules/](modules/) contains differentiable effects implemented in PyTorch for loading the presets and applying them to audio data.
|
| 29 |
+
|
| 30 |
+
## Sample Usage
|
| 31 |
+
|
| 32 |
+
For concrete examples of how to use the dataset and its associated code, please refer to the original GitHub repository. Below is a quick start example demonstrating how to set up the environment and run the retrieval process on a single track:
|
| 33 |
+
|
| 34 |
+
First, install the required Python packages by cloning the original repository and installing its requirements:
|
| 35 |
+
```bash
|
| 36 |
+
git clone https://github.com/SonyResearch/diffvox.git
|
| 37 |
+
cd diffvox
|
| 38 |
+
pip install -r requirements.txt
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
Then, you can run the vocal effects retrieval process on a specific track. For example, to process a track from MedleyDB:
|
| 42 |
+
```bash
|
| 43 |
+
python main.py data_dir=/data/medley1/v1/Audio/AimeeNorwich_Child --dataset=medley_vocal --log_dir=~/medley_vocal_log
|
| 44 |
+
```
|
| 45 |
+
This command will run the retrieval process on valid vocal tracks within the specified directory and save the training logs and best checkpoints to `~/medley_vocal_log`. Refer to the original repository's `main.py` and `cfg/config.yaml` for configuration details.
|