Datasets:

License:
jeremery123lc commited on
Commit
1fbfba7
·
verified ·
1 Parent(s): 631325b

Document schema, provenance and licensing in English dataset card

Browse files
Files changed (1) hide show
  1. README.md +109 -68
README.md CHANGED
@@ -1,109 +1,150 @@
1
  ---
2
  language: [de, en, fr, ja, ko, zh]
3
  license: cc-by-nc-4.0
4
- pretty_name: Emilia Complete - Audio TAR and SCP
5
- tags: [audio, speech, emilia]
6
- configs:
7
- - config_name: default
8
- default: true
9
- data_files:
10
- - split: train
11
- path: audio/*.tar
12
  ---
13
 
14
- # Emilia_complete:音频 TAR + 单一 SCP
15
 
16
- 本版本仅包含本地 `Emilia_complete` 的六语言全量音频,共 **9,310,186 条**。
17
- 未应用中英文严格筛选清单,不包含 Emilia-YODAS 或其他数据集。
18
- `complete` 是本地目录名,不代表完整覆盖上游 Emilia。
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
 
20
  ```text
21
- emilia_complete_scp_release/
22
- ├── audio/ # 666 个原始 TAR 分片
23
  │ ├── DE-B000000.tar
24
  │ ├── EN-B000000.tar
25
  │ └── ...
26
- ├── metrics.scp # 唯一 SCP,含表头及全部六语言记录
27
- ├── dataset_statistics.json
28
- ├── SHA256SUMS # metrics.scp 的 SHA-256
29
  ├── LICENSE
30
  └── README.md
31
  ```
32
 
33
- `metrics.scp` 是 UTF-8、TAB 分隔的 34 列文本表。所有原始字段、列顺序和数值
34
- 字符串均保留,只将 `path` 改成相对于本目录的音频位置:
35
 
36
  ```text
37
  audio/DE-B000000.tar:512:154989
38
  ```
39
 
40
- 含义依次是:**TAR 相对路径 : 音频内容起始字节偏移 : 音频内容字节数**。
41
- 偏移指向 MP3 内容,不是 TAR 文件头;读取指定长度即可取得完整编码音频。
42
- TAR 内保留原有数字文件名,音频的原始 Emilia ID 由 SCP 的 `uid` 列给出。
43
-
44
- ## 字段
45
-
46
- ```text
47
- datasets uid fs path length(s) silerovad webrtcvad transcript confidence
48
- dnsmos scoreq squim_pesq squim_sisdr squim_stoi srmr vqscore wadasnr
49
- distillmos utmos dnsmos_pro nisqa sigmos_ovrl sigmos_col sigmos_disc
50
- sigmos_loud sigmos_noise sigmos_reverb sigmos_sig ced flexsed panns beats
51
- speaker_count overlap_ratio
52
- ```
53
-
54
- 上面为便于阅读以空格换行展示,实际 SCP 使用 TAB 分隔。
55
- `datasets` 均为 `Emilia_complete`;`fs` 为原清单采样率,`length(s)` 为已有时长,
56
- `transcript` 为已有转写。其余指标沿用源表,不重新计算、不改精度、不推测模型版本。
57
- 保留指标字符串中的原始空值或其他标记;标注存在不等于经过人工确认。
58
-
59
- ## 读取示例
60
-
61
- 该 SCP 需要按表解析,不能直接使用空白字符 `split()`,因为转写中可能含空格。
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
62
 
63
  ```python
64
  import csv
65
  from pathlib import Path
66
 
67
- root = Path("/path/to/emilia_complete_scp_release")
68
  with (root / "metrics.scp").open(encoding="utf-8", newline="") as f:
69
- rows = csv.DictReader(f, delimiter="\t", quoting=csv.QUOTE_NONE)
70
- row = next(rows)
71
 
72
  relative, offset, size = row["path"].rsplit(":", 2)
73
  with (root / relative).open("rb") as f:
74
  f.seek(int(offset))
75
  audio_bytes = f.read(int(size))
76
  assert len(audio_bytes) == int(size)
77
- print(row["uid"], row["transcript"], row["dnsmos"])
78
 
79
- # 可选:解码 MP3
80
- # import io, soundfile as sf
 
81
  # waveform, sample_rate = sf.read(io.BytesIO(audio_bytes))
82
  ```
83
 
84
- 发布到 Hugging Face 后,下载该目录即可按以上方式使用。Hub 的普通 WebDataset
85
- 加载器可以读取 TAR 音频,但**不会自动将这个自定义 SCP 的 34 列与音频合并**。
86
- 完整转写和指标请按 SCP 的路径、偏移及长度读取,不要把 TAR 内的数字名当作原始 UID。
87
- 如果需要音频和 JSON 标注原生配对的 WebDataset,可使用此前另行整理的版本。
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
88
 
89
- ## 整理与核对
90
 
91
- - 六语言原始清单逐条核对 UID、采样率和原始路径/偏移/长度。
92
- - 合并原 `metrics_dataset` 当前六个 SCP 中 `datasets == Emilia_complete` 的记录。
93
- - 一条 UID 只允许出现一次,要求所有音频清单记录都有对应 SCP 行。
94
- - 完整回读输出 SCP,核对 34 列、行数、路径存在性、偏移边界和文件 SHA-256。
95
- - 音频不重采样、不转码、不解包重写。服务器上的 TAR 使用原始 TAR 的硬链接,
96
- 避免重复占用音频空间;应视为只读。如需修改 TAR,请先创建独立副本。
97
- 上传到 Hub 时会上传普通文件内容,不依赖服务器硬链接关系。
98
 
99
- 本次只整理存储布局;未额外进行全量音频解码、内容审查或评分。
100
- 此前原生 WebDataset 整理已完整验证原始 TAR 成员与清单偏移、长度及音频内容。
101
 
102
- ## 来源与许可
103
 
104
- 来源:[原版 Emilia](https://huggingface.co/datasets/amphion/Emilia-Dataset)。
105
- 上游对原版 Emilia 指定 **CC BY-NC 4.0**,并有额外访问条款;本数据不适用
106
- Emilia-YODAS 的 CC BY 4.0。权利归 Emilia 作者及原始录音权利人,未暗示上游认可本版本。
107
- 本地筛选历史、上游下载版本和逐条再分发授权没有在现有清单中完整记录。
108
- 技术格式整理不等于公开再分发授权已经确认;公开上传前须核实适用条款及授权。
109
- 本次整理未创建 Hub 仓库或上传数据。
 
1
  ---
2
  language: [de, en, fr, ja, ko, zh]
3
  license: cc-by-nc-4.0
4
+ pretty_name: Emilia ERT
5
+ size_categories:
6
+ - 1M<n<10M
7
+ tags: [audio, speech, speech-quality, speech-metrics, emilia]
 
 
 
 
8
  ---
9
 
10
+ # Emilia ERT
11
 
12
+ ## Dataset summary
13
+
14
+ Emilia ERT contains **9,310,186 speech segments** in six languages, distributed as **666 audio TAR shards** and a single **34-column metadata table**, `metrics.scp`. It packages the entire locally retained `Emilia_complete` collection from a filtering workflow, with existing transcripts and automatic audio metrics.
15
+
16
+ `Emilia_complete` identifies the local source collection; it does **not** mean this repository contains the complete upstream release. No additional English/Chinese-only selection was applied during release preparation. This is an independently prepared collection in the AudioCC-Lab namespace, not an official Amphion release.
17
+
18
+ | Language | Code | Segments | TAR shards |
19
+ | --- | --- | ---: | ---: |
20
+ | German | de | 166,600 | 10 |
21
+ | English | en | 4,619,380 | 333 |
22
+ | French | fr | 78,751 | 12 |
23
+ | Japanese | ja | 203,264 | 27 |
24
+ | Korean | ko | 11,640 | 1 |
25
+ | Chinese | zh | 4,230,551 | 283 |
26
+ | **Total** | | **9,310,186** | **666** |
27
+
28
+ Audio archives occupy 665,879,367,680 bytes; `metrics.scp` occupies 6,134,693,898 bytes. No held-out evaluation split is provided. Define appropriate speaker/source-disjoint splits for experiments.
29
+
30
+ ## Files and audio addressing
31
 
32
  ```text
33
+ .
34
+ ├── audio/
35
  │ ├── DE-B000000.tar
36
  │ ├── EN-B000000.tar
37
  │ └── ...
38
+ ├── metrics.scp
39
+ ├── SHA256SUMS
 
40
  ├── LICENSE
41
  └── README.md
42
  ```
43
 
44
+ `metrics.scp` is a UTF-8, TAB-separated table with a header, despite its extension. It is not a conventional two-column Kaldi SCP. Column order, values, precision, and source missing-value markers were preserved; only `path` was converted to a repository-relative locator:
 
45
 
46
  ```text
47
  audio/DE-B000000.tar:512:154989
48
  ```
49
 
50
+ The components are **TAR path : byte offset : byte length**. The offset points to the encoded MP3 payload, not the TAR header. Archive members retain their local numeric names; `uid` supplies the original-style Emilia identifier. Archives were retained byte-for-byte without re-encoding during release preparation. Do not recompress or rebuild them while using these offsets.
51
+
52
+ ## Metadata fields
53
+
54
+ Types describe valid values; all cells are stored as text. Handle missing or nonnumeric markers explicitly rather than converting them to zero.
55
+
56
+ | # | Field | Type / unit | Meaning |
57
+ | ---: | --- | --- | --- |
58
+ | 1 | `datasets` | string | Local source label; `Emilia_complete` throughout this release. |
59
+ | 2 | `uid` | string | Segment identifier, e.g. `DE_B00008_S00023_W000000`; the prefix identifies the source language. |
60
+ | 3 | `fs` | integer, Hz | Sample rate recorded in the source manifest. Scoring models may internally resample audio. |
61
+ | 4 | `path` | string | Relative TAR path, payload offset, and payload length, separated by colons. |
62
+ | 5 | `length(s)` | float, seconds | Segment duration from the source table. |
63
+ | 6 | `silerovad` | float, fraction | Silero VAD detected-speech duration divided by total duration. |
64
+ | 7 | `webrtcvad` | float, fraction | Speech fraction estimated by the WebRTC VAD workflow. |
65
+ | 8 | `transcript` | string | Automatic transcript from the local WhisperX workflow; not a verified human transcription. |
66
+ | 9 | `confidence` | float, score | Mean of available WhisperX aligned-word scores in the inspected implementation; not a calibrated probability of transcript correctness. |
67
+ | 10 | `dnsmos` | float, predicted MOS | DNSMOS overall quality output (`DNSMOS_OVRL`). |
68
+ | 11 | `scoreq` | float, model score | SCOREQ speech-quality estimate on the model's native scale. |
69
+ | 12 | `squim_pesq` | float, predicted score | SQUIM estimate of PESQ without a clean reference. |
70
+ | 13 | `squim_sisdr` | float, predicted dB | SQUIM estimate of scale-invariant signal-to-distortion ratio (SI-SDR). |
71
+ | 14 | `squim_stoi` | float, predicted score | SQUIM estimate of short-time objective intelligibility (STOI). |
72
+ | 15 | `srmr` | float, ratio | Speech-to-reverberation modulation energy ratio, a non-intrusive reverberation-related measure. |
73
+ | 16 | `vqscore` | float, model score | VQScore non-intrusive speech-quality estimate. |
74
+ | 17 | `wadasnr` | float, dB | Signal-to-noise ratio estimated using waveform amplitude distribution analysis (WADA-SNR). |
75
+ | 18 | `distillmos` | float, predicted MOS | DistillMOS speech-quality estimate. |
76
+ | 19 | `utmos` | float, predicted MOS | UTMOS speech-quality estimate. |
77
+ | 20 | `dnsmos_pro` | float, model score | DNSMOS Pro quality output retained from the local scoring workflow. |
78
+ | 21 | `nisqa` | float, predicted MOS | NISQA overall quality estimate (`NISQA_MOS`). |
79
+ | 22 | `sigmos_ovrl` | float, predicted rating | SIGMOS overall quality rating. |
80
+ | 23 | `sigmos_col` | float, predicted rating | SIGMOS coloration-related quality rating. |
81
+ | 24 | `sigmos_disc` | float, predicted rating | SIGMOS discontinuity-related quality rating. |
82
+ | 25 | `sigmos_loud` | float, predicted rating | SIGMOS loudness-related quality rating. |
83
+ | 26 | `sigmos_noise` | float, predicted rating | SIGMOS background-noise-related quality rating. |
84
+ | 27 | `sigmos_reverb` | float, predicted rating | SIGMOS reverberation-related quality rating. |
85
+ | 28 | `sigmos_sig` | float, predicted rating | SIGMOS speech-signal quality rating. |
86
+ | 29 | `ced` | float, probability score | Maximum CED probability over the workflow's selected noise/event classes (AudioSet indices 72 onward). |
87
+ | 30 | `flexsed` | float, probability score | Maximum FlexSED probability over selected noise/event prompts and time frames in the inspected workflow. |
88
+ | 31 | `panns` | float, probability score | Maximum PANNs clip-level probability over selected classes at AudioSet indices 72 onward. |
89
+ | 32 | `beats` | string | BEATs highest-scoring selected non-speech event label followed by its score, e.g. `Inside, small room 0.0067`. Split from the right to extract the final numeric score. |
90
+ | 33 | `speaker_count` | integer, count | Number of Sortformer speaker streams meeting minimum active-duration criteria; not a verified count of distinct people. |
91
+ | 34 | `overlap_ratio` | float, fraction | Fraction of analyzed frames with at least two active speaker streams after thresholding and short-run removal. The denominator includes all analyzed frames, not only speech. |
92
+
93
+ Meanings were checked against available local assembly and scoring scripts. Exact historical checkpoints, command-line settings, and per-row generation versions are not fully recorded. Current script defaults are not guaranteed historical settings.
94
+
95
+ MOS fields are model predictions, not listening-test ratings. SQUIM outputs are predictions rather than reference-based measurements. SIGMOS dimensions describe quality, not physical noise power or reverberation time. The SED class selection is a workflow convention; event scores are not human-confirmed noise labels. Different models' scores are not interchangeable, and this release defines no universal quality threshold.
96
+
97
+ ## Usage
98
+
99
+ Download `metrics.scp` and the required shards, then parse with an explicit TAB delimiter. Plain whitespace splitting would corrupt transcripts and event labels.
100
 
101
  ```python
102
  import csv
103
  from pathlib import Path
104
 
105
+ root = Path("/path/to/Emilia_ERT")
106
  with (root / "metrics.scp").open(encoding="utf-8", newline="") as f:
107
+ row = next(csv.DictReader(f, delimiter="\t", quoting=csv.QUOTE_NONE))
 
108
 
109
  relative, offset, size = row["path"].rsplit(":", 2)
110
  with (root / relative).open("rb") as f:
111
  f.seek(int(offset))
112
  audio_bytes = f.read(int(size))
113
  assert len(audio_bytes) == int(size)
114
+ print(row["uid"], row["transcript"])
115
 
116
+ # Optional MP3 decoding with a compatible libsndfile installation:
117
+ # import io
118
+ # import soundfile as sf
119
  # waveform, sample_rate = sf.read(io.BytesIO(audio_bytes))
120
  ```
121
 
122
+ This custom TAR/SCP layout requires a table-driven reader. An automatic WebDataset loader does not join SCP annotations to archive members. For efficient training, group reads by shard and reuse file handles. `SHA256SUMS` records the SHA-256 of `metrics.scp`.
123
+
124
+ ## Provenance and preparation
125
+
126
+ The upstream dataset is [Emilia, by Haorui He and collaborators / Amphion](https://huggingface.co/datasets/amphion/Emilia-Dataset). Local records identify the original Emilia branch; no Emilia-YODAS collection was included.
127
+
128
+ Immediate inputs were the six-language `30wh_filter/data/Emilia_complete` audio collection, its language manifests, and corresponding rows in six `metrics_dataset.*.scp` tables. Preparation consolidated those rows, preserved audio bytes and metric values, and replaced local addresses with relative TAR locators. It did not rerun ASR, scoring, diarization, or filtering. Record IDs, source locators, and all non-path fields were checked during preparation.
129
+
130
+ The exact upstream download revision, complete earlier filtering history, original media URLs, and per-record rights records are not supplied. Local consistency checks do not establish a complete upstream provenance or permission chain.
131
+
132
+ ## License and access review
133
+
134
+ Reviewed on **2026-09-18**. The [upstream card and access terms](https://huggingface.co/datasets/amphion/Emilia-Dataset) distinguish original Emilia (**CC BY-NC 4.0**) from Emilia-YODAS (**CC BY 4.0**). This repository retains `cc-by-nc-4.0`; the combined upstream repository's license badge should not be used to relabel original Emilia. Upstream states that recording copyright remains with the original owners.
135
+
136
+ [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/legalcode.en) permits noncommercial sharing and adaptation within the licensor's rights, subject to attribution, a license reference, retention of supplied notices, and indication of changes. It does not independently clear third-party rights. See [LICENSE](LICENSE) for the attribution notice. This repackaging claims no upstream endorsement or new ownership of recordings.
137
+
138
+ **Unresolved release condition:** upstream access terms require associates or colleagues receiving access to agree to those terms first. Available records do not establish how unrestricted public mirroring satisfies this condition or document permission for that distribution arrangement. README text alone does not enforce acceptance. Compliance of unrestricted redistribution is therefore **not confirmed**. The maintainer should obtain upstream clarification/authorization and establish the appropriate access arrangement before treating this release as cleared for unrestricted distribution. Gating alone would not establish recording-level rights.
139
+
140
+ The license label records the upstream designation, not certification that every recording or annotation has been cleared. Provenance and licensing of annotation-generating models/checkpoints are not fully documented here either.
141
 
142
+ ## Limitations and responsible use
143
 
144
+ Languages are strongly imbalanced. Automatic transcripts, speaker estimates, and quality/event scores can be wrong and may behave differently across languages and recording conditions. No guarantee of absence of personal information or sensitive content is made. Evaluate suitability and rights for the intended use; metadata scores are not human approval or authorization to impersonate speakers.
 
 
 
 
 
 
145
 
146
+ For dataset questions or rights concerns, contact maintainers through this repository's Community page. Avoid posting personal information publicly.
 
147
 
148
+ ## Citation
149
 
150
+ Credit the original Emilia authors and cite their [2024 paper](https://arxiv.org/abs/2407.05361) and, where relevant, the [2025 extended paper](https://arxiv.org/abs/2501.15907). Also identify this repository and the commit used to distinguish its local selection and added metadata from upstream Emilia.