Hamozwa commited on
Commit
f0b87c3
·
verified ·
1 Parent(s): 5b92044

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -26
README.md CHANGED
@@ -225,56 +225,60 @@ configs:
225
  path: rvn-features/test-*
226
  license: cc-by-nc-4.0
227
  ---
228
-
229
  # Dataset Card for RepeatSynth
230
-
231
  Synthetic portion of the audio datasets referenced in *Class-Agnostic Audio Repetition Counting*.
232
-
233
  Code: https://github.com/Hamozwa/audio-counting
234
-
235
  ## Dataset Summary
236
-
237
  RS, RSN, and RVN are synthetic datasets containing varying levels of background noise. Every sample is uniformly 10 seconds long and contains between 0 and 8 repetition events.
238
-
239
  | Config | Description |
240
  |---|---|
241
  | `rs` | RepeatSound — clean, no added background noise |
242
  | `rsn` | RepeatSoundNoisy — background noise added |
243
  | `rvn` | RepeatVeryNoisy — the noisiest condition |
244
-
245
- Each config has `train`, `validation`, and `test` splits.
246
-
247
  ```python
248
  from datasets import load_dataset
249
  ds = load_dataset("Hamozwa/RepeatSynth", "rsn", split="train")
250
  ```
251
-
252
  ## Dataset Structure
253
-
254
- | Field | Type | Description |
255
- |---|---|---|
256
- | `audio` | `Audio` | The 10-second wav clip |
257
- | `id` | `string` | Original filename stem |
258
- | `original_source` | `string` | The FSD50K clip this sample's repeated event was built from |
259
- | `num_repetitions` | `int` | Ground-truth repetition count (0–8) |
260
- | `events` | `list[{start: float, end: float}]` | Onset/offset (seconds) of each repeated event within the clip |
261
-
 
 
 
 
262
  ## Dataset Sources
263
-
264
  Synthetic clips were generated by combining two source collections:
265
-
266
  - FSD50K — https://zenodo.org/records/4060432 — provided the audio for each repeated event
267
  - MUSAN — http://openslr.org/ — used as background noise
 
268
  ## Licensing
269
-
270
  This is a derivative work built from two source collections, each with different terms. Both require attribution.
271
-
272
  **FSD50K** licenses each clip individually rather than as a whole collection (CC0, CC-BY, CC-BY-NC, or CC Sampling+, depending on the clip). Since every sample here is built from one specific FSD50K clip, the `original_source` field lets you look up that clip's exact license via FSD50K's own `dev_clips_info_FSD50K.json` / `eval_clips_info_FSD50K.json` mapping files. If you plan to use or redistribute a subset commercially, check the license of every clip referenced by `original_source` first — some are CC-BY-NC and restrict commercial reuse.
273
-
274
  **MUSAN** is released under CC BY 4.0 (https://openslr.org/17/) — attribution required, otherwise unrestricted.
275
-
276
  ## Citation
277
-
278
  ```bibtex
279
  [Your paper's BibTeX entry here]
280
  ```
 
225
  path: rvn-features/test-*
226
  license: cc-by-nc-4.0
227
  ---
 
228
  # Dataset Card for RepeatSynth
229
+
230
  Synthetic portion of the audio datasets referenced in *Class-Agnostic Audio Repetition Counting*.
231
+
232
  Code: https://github.com/Hamozwa/audio-counting
233
+
234
  ## Dataset Summary
235
+
236
  RS, RSN, and RVN are synthetic datasets containing varying levels of background noise. Every sample is uniformly 10 seconds long and contains between 0 and 8 repetition events.
237
+
238
  | Config | Description |
239
  |---|---|
240
  | `rs` | RepeatSound — clean, no added background noise |
241
  | `rsn` | RepeatSoundNoisy — background noise added |
242
  | `rvn` | RepeatVeryNoisy — the noisiest condition |
243
+
244
+ Each config has `train`, `validation`, and `test` splits. `rs-features`, `rsn-features`, and `rvn-features` hold precomputed spectrograms and self-similarity matrices for the same clips (see "Feature configs" below) — most users only need the main configs above.
245
+
246
  ```python
247
  from datasets import load_dataset
248
  ds = load_dataset("Hamozwa/RepeatSynth", "rsn", split="train")
249
  ```
250
+
251
  ## Dataset Structure
252
+
253
+ | Field | Type | Description | Why it's here |
254
+ |---|---|---|---|
255
+ | `audio` | `Audio` | The 10-second wav clip | The actual training/test input |
256
+ | `id` | `string` | Original filename stem | Lets you cross-reference against the `-features` configs or reconstruct the original file layout |
257
+ | `original_source` | `string` | The FSD50K clip this sample's repeated event was built from | Required for attribution — FSD50K licenses each clip individually, so this is what you check to find the license of the audio actually used in a given sample |
258
+ | `num_repetitions` | `int` | Ground-truth repetition count (0–8) | The label WavCounter and TSSMCounter are trained/evaluated against |
259
+ | `events` | `list[{start: float, end: float}]` | Onset/offset (seconds) of each repeated event within the clip | Used to build the target heatmap WavCounter regresses against, rather than just a single count — this is what lets the model localize events in time, not just count them |
260
+
261
+ ## Feature configs
262
+
263
+ `rs-features`/`rsn-features`/`rvn-features` contain `id`, `spectrogram`, and `tssm` (temporal self-similarity matrix) columns: the precomputed inputs TSSMCounter and spectrogram baseline actually train on, joinable back to the main config via `id`. These are included for convenience and exact reproducibility, but are fully derivable from the `audio` column above via the preprocessing code in the linked repo, so they're kept as separate configs rather than bundled into the main table.
264
+
265
  ## Dataset Sources
266
+
267
  Synthetic clips were generated by combining two source collections:
268
+
269
  - FSD50K — https://zenodo.org/records/4060432 — provided the audio for each repeated event
270
  - MUSAN — http://openslr.org/ — used as background noise
271
+
272
  ## Licensing
273
+
274
  This is a derivative work built from two source collections, each with different terms. Both require attribution.
275
+
276
  **FSD50K** licenses each clip individually rather than as a whole collection (CC0, CC-BY, CC-BY-NC, or CC Sampling+, depending on the clip). Since every sample here is built from one specific FSD50K clip, the `original_source` field lets you look up that clip's exact license via FSD50K's own `dev_clips_info_FSD50K.json` / `eval_clips_info_FSD50K.json` mapping files. If you plan to use or redistribute a subset commercially, check the license of every clip referenced by `original_source` first — some are CC-BY-NC and restrict commercial reuse.
277
+
278
  **MUSAN** is released under CC BY 4.0 (https://openslr.org/17/) — attribution required, otherwise unrestricted.
279
+
280
  ## Citation
281
+
282
  ```bibtex
283
  [Your paper's BibTeX entry here]
284
  ```