Datasets:
File size: 36,271 Bytes
bd4b538 cc02077 bd4b538 cc02077 b239143 5b9f5a4 a47e6ef 5b9f5a4 bd4b538 cc02077 bd4b538 5b9f5a4 bd4b538 92df43e cc02077 bd4b538 5b9f5a4 bd4b538 cc02077 bd4b538 cc02077 bd4b538 5b9f5a4 bd4b538 cc02077 bd4b538 cc02077 bd4b538 cc02077 bd4b538 5b9f5a4 bd4b538 cc02077 5b9f5a4 bd4b538 5b9f5a4 8184d5e cc02077 5b9f5a4 cc02077 bd4b538 598450c 5b9f5a4 c75fc59 5b9f5a4 bd4b538 cc02077 bd4b538 cc02077 74f8f28 cc02077 4529577 74f8f28 cc02077 74f8f28 cc02077 74f8f28 cc02077 74f8f28 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | [返回 README.zh.md](../README.zh.md)
<!-- Generated by artpool.index_projection from meta/, cards/*.yaml, the field registry and its templates. Every release regenerates it, so edits to this file do not last. -->
# 字段
[English](fields.md) | 简体中文
## 仓库结构
- `data/`: 所有行:打包在少数几个大文件 `rows-<number>.parquet` 中(每个约 100 MB 到 1 GB),按来源和单元排序:大来源有自己的文件,小来源共用一个;`source` 和 `batch` 两列说明一行属于哪个来源和批次;每个键(source、uri、range_offset、member_path)一行:更正后的行替换旧行,旧行所在的文件去掉它后被重写。`meta/catalog.parquet` 的 `data_files` 列列出存放每个来源各行的文件:读这些文件,不要列出 `data/`。
- [`meta/catalog.parquet`](../meta/catalog.parquet): 每个来源一行:它的种类(语料库或材料集)、是什么、大小、类型、许可证等级和登录要求(子集 `catalog`)。
- [`meta/preview.parquet`](../meta/preview.parquet): 每个来源的 10 行,列与 `data/` 相同(子集 `preview`);单个来源从它在 `meta/catalog.parquet` 中那一行的 `data_files` 列出的数据文件整体读取,每个文件读一次,不列出 `data/`。
- [`meta/sizes.parquet`](../meta/sizes.parquet): 实测大小:每个数据文件中抽取的一组行,每行有记录的大小、通过下载、从归档中读出成员或请求第一个字节测得的大小,以及是否一致(列见下面的“实测大小”一节)。
- [`meta/size_figures.json`](../meta/size_figures.json): 本次发布的数字,每个合计只算一次:每个层级(整个索引、两层、每个合集、语料库的每个主要领域和每个来源)的计数和大小数字:记录的大小、去重后大小、对照 `meta/sizes.parquet` 的核对,以及没有记录大小的行的估计及其范围;还有数据集卡片各表给出的事实和发布天数。数据集卡片、这些页面和数据页都从这里读取数字。
- [`meta/stage_figures.json`](../meta/stage_figures.json): 按训练阶段的计数:代码仓库 `catalog/stages.yaml` 阶段表中的每个阶段(后训练按材料集、单元和它们所来自的上游来源计;中训练和预训练按语料库的行数和字节数计),在 `meta/stage_fields.parquet` 上求得,并注明所用阶段表的版本;每个阶段带有它的漏斗:各阶段共用的各条规则之前、以及按顺序(benchmark、not compared、personal data、duplicate)每条规则之后的计数。
- [`meta/stage_fields.parquet`](../meta/stage_fields.parquet): 阶段表的条件所读的字段,覆盖材料集的每个单元和语料库的每一行,并记录它按顺序通过了各阶段共用规则中的几条(passed):每个来源与文件类型、训练和再分发许可、语言和大小核对、上游以及通过规则数的每种组合一行,带单元数、行数和字节数;没有哪一列记录阶段,所以改阶段表不需要重新扫描。
- [`meta/translations.parquet`](../meta/translations.parquet): 中文页面显示的每个名称和描述的中文版本(合集、每个来源的标题、描述和摘要、训练阶段):每段英文一行,以它的 sha256 为键,由语言模型翻译一次。
- [`meta/vocabulary.json`](../meta/vocabulary.json): `domain` 的代码及其名称,以及 `form` 的标识,各带一句说明其含义的话;两层、各合集,以及每个中文页面都使用的中文术语表(`terms`)。
- [`meta/sources.json`](../meta/sources.json): 每个来源的详情:描述、每个批次的许可证、布局、按类型和大小的计数。
- [`meta/coverage.json`](../meta/coverage.json): 按许可证等级、来源、单元、大小和标签的合计;`projections.license_unknown`:等级为 unknown 的许可证写法,是来源的(层级 `source`)或其中的行自己声明的(层级 `row`),每种带原因码(`unrecognized`:表达式无法解析,或其中的许可证两张表都没有)、来源数和行数,供人逐一读一次;`projections.leaves`:领域网格的每个叶子下,标到它的基准测试任务数(一个任务是某个基准测试某一版本里的一道题,即代码仓库 `catalog/bench_leaves.tsv` 的一行)和基准测试数,以及那里可用的材料集数和它们的单元数。
- [`meta/batches.parquet`](../meta/batches.parquet): 每个批次一行,带它的许可证等级。
- [`meta/tags.parquet`](../meta/tags.parquet): 哪些行属于哪个活动标签(`campaign:<name>`,一个合集的材料集的一个批次)。
- [`meta/bench_overlap.parquet`](../meta/bench_overlap.parquet): 与公开基准测试任务相符的行,范围是按 `meta/projection.json` 中所记键版本(bench_keys)比对过的数据文件;[for-agents.zh.md](for-agents.zh.md) 说明比对了多少个来源。
- [`meta/bench_checked.parquet`](../meta/bench_checked.parquet): 与基准测试清单比对过的数据文件;数据文件不在其中的行没有比对过。
- [`meta/benchmarks.parquet`](../meta/benchmarks.parquet): 基准测试清单:每个基准测试条目一行(公开、需登录或不公开),带它的版本、权重、许可证、页面、任务数、它所属的指数以及按领域网格叶子统计的任务数;不含任务文本。
- [`meta/attribution.parquet`](../meta/attribution.parquet): 材料集每个文件的发布方和许可证:每个来源、发布方、许可证和许可证链接的组合一行,附文件数;行上没有写明的文件,沿用其来源的许可证和许可证链接(`meta/sources.json`)。
- [`meta/size_caps.json`](../meta/size_caps.json): `tools/fetch.py` 下载时采用的总体大小上限。
- [`meta/croissant.json`](../meta/croissant.json): 目录和每个来源的 Croissant 元数据(JSON-LD)。
- [`meta/not_included.parquet`](../meta/not_included.parquet): 未收录的单元,每个都写明它不满足的要求(见 [access.zh.md](access.zh.md))。
- `cards/`: 每个来源一张卡片:`<source>.yaml` 含每个字段及其依据,`<source>.md` 供阅读。
- `campaign_files/`: 存放在本仓库中的文件,属于行指向这里的材料集(索引为每个材料集写的 README.md 和 LICENSE、为软件包写的文件)。
- `tools/`: `fetch.py` 挑选、下载并校验文件,并按构建任务所需的结构摆放(见 [for-agents.zh.md](for-agents.zh.md));存放在容器里的单元,它直接写出单元本身,并按单元的哈希值校验;`to_pool.py` 解开标为 expand 的单元,写出一个合集的任务池及其交付记录。
- `docs/`: `selecting.md`:字段、默认筛选和示例;`sources.md`、`fields.md`、`for-agents.md` 和 `access.md`:数据集卡片链接到的详情;每页旁边都有中文版 `<name>.zh.md`;`banner.svg` 和 `banner.zh.svg`:英文和中文卡片的横幅;`figures/`:卡片的图,每次发布由 `meta/size_figures.json` 画出,每张图有浅色和深色两版(对应 Hub 的两种主题)、宽和窄两版,中文卡片的图为 `<name>.zh.svg`。
- [`CHANGELOG.md`](../CHANGELOG.md): 每次发布改了什么。
- [`NOTICE`](../NOTICE): ScanCode LicenseDB 的署名(CC-BY-4.0):本数据集的许可证等级和原因码由它的许可证类别算出。
## 行字段
`data/` 下数据文件的行列(每个来源都相同;`meta/catalog.parquet` 的 `data_files` 列列出每个来源的文件):
| 列 | 类型 | 含义 |
|---|---|---|
| `source` | 文本 | 来源名称;与 data/ 下的文件夹名相同。 |
| `batch` | 文本 | 该行发布时所在的批次;它的许可证是 meta/sources.json 中的 batches[].license。 |
| `collection` | 文本 | 来源内部按来源自己的命名所分的组(一个项目、一次抓取、一个列表),有的话才有。 |
| `ext` | 文本 | 取自上游文件名的扩展名,小写;文件名没有扩展名时为空。 |
| `uri` | 文本 | 下载该条目的地址(https、s3、git、rsync 或 hf);存放在本仓库中的行给出 campaign_files/ 下的路径。 |
| `range_offset` | 整数 | 条目是更大文件中的一条记录时(网页存档记录、字节范围):它的起始位置,以字节计。 |
| `range_length` | 整数 | 这条记录的字节长度;整个文件时为空。 |
| `member_path` | 文本 | 条目是存档中的一个文件时:它在存档内的路径。 |
| `parent_pointer_id` | 文本 | 条目是成员时:它所属的存档或容器的标识。 |
| `zip_local_header_offset` | 整数 | zip 存档的成员:它的本地文件头的偏移,以便用一次范围请求读取。 |
| `zip_compression_method` | 整数 | zip 存档的成员:它的压缩方法(0 为存储,8 为 deflate)。 |
| `zip_compressed_size` | 整数 | zip 存档的成员:它压缩后的字节数。 |
| `size_bytes` | 整数 | 交付时条目的字节数;来源没有公布时为空。 |
| `media_type` | 文本 | 已知时为该条目的媒体类型。 |
| `sha256` | 32 字节 | 该条目的 SHA-256,32 字节(转成十六进制后比较);未知时为空。 |
| `sha1` | 20 字节 | 来源公布时为该条目的 SHA-1,20 字节。 |
| `md5` | 16 字节 | 来源公布时为该条目的 MD5,16 字节。 |
| `crc32` | 4 字节 | 来源公布时为该条目的 CRC-32,4 字节。 |
| `origin_url` | 文本 | 发现该条目的页面或记录,与 uri 不同时才有。 |
| `origin_time` | 文本 | 来源给出的该条目时间(网页存档为抓取时间),照原样记录。 |
| `truncated` | 文本 | 指针背后的内容在来源处被截断时(例如被截断的 API 响应体)有值;否则为空。 |
| `license_spdx` | 文本 | 该行自己的许可证,为 SPDX 表达式;沿用批次许可证时为空。 |
| `license_training_ok` | 文本 | 该行自己的训练等级(yes、conditional、no);沿用批次等级时为空。 |
| `license_redistribution_ok` | 文本 | 该行自己的再分发等级(yes、conditional、no);沿用批次等级时为空。 |
| `license_notes` | 文本 | 关于该行自己许可证的说明。 |
| `sensitive` | 文本 | 条目涉及健康或未成年人时为 health 或 minors;否则为空。 |
| `collected_at` | 文本 | 该行被采集的时间(UTC,YYYY-MM-DDTHH:MM:SSZ):采集器写出该行所在分片时记录的时间(材料集为采集器发出该行所在文件的时间),该行的文件重写时保持不变;同一键下的多行中,快照保留最后采集的那一行。没有记录时间时为空(加入该列之前写入的行,或采集器开始记录时间之前采集的行);这样的行按其批次日期的 UTC 零点排序;批次名称中没有日期时,排在所有有时间的行之下。 |
| `extra` | 文本 | 该行其余字段的 JSON(例如它自己的 access.needs_auth 或来源特有的元数据)。材料集的行在 extra.source_meta 中记录它在任务池中的位置:unit_group(该行所属单元的键 `unit_id`,由单元的各个文件共用)、pool_path、pool_leaf 和 pool_fields;`tools/fetch.py` 把它们写进清单。由检索候选收录的材料集,其行在 extra.source_meta.labels 中带有标签:language(ISO 639;zxx 表示没有语言内容)、pool_status(accepted、pending 或 pool_rejected,附 pool_reject_category 和 pool_reject_reason)、robots、terms,以及来源另有设定时单元自己的 domain 和 leaf。 |
## 目录字段
`meta/catalog.parquet` 的列(每个来源一行)。
`domain` 和 `form` 来自流水线仓库的目录规则(`catalog/rules.tsv`,否则取该来源在 `meta/sources.json` 中的注册信息),见下面它们各自的行。
`kind` 说明该来源是语料库(`corpus`)还是材料集(`material_set`),按下面它那一行给出的规则,从该来源在 `meta/sources.json` 中的条目算出;
用 `WHERE kind = 'corpus'` 或 `WHERE kind = 'material_set'` 选出一种,因为材料集的单元和语料库的行从不相加。
`collection` 给出材料集所属的合集,即流水线 `admit_collections.tsv` 中一行的代码(A、B、C、G、GT、HW、M、MD、ML、OP、S、SC、SW;名称见 `meta/vocabulary.json`),从该材料集的活动批次查出,且只在材料集满足该合集定义所收录的内容(`catalog/domains.yaml` 中的 `admits`)时才保留;
对语料库,这一列是在 `catalog/domains.yaml` 的 `corpora` 下列出它的合集(该语料库装的是这个合集那一类材料,仍按行计数,从不与合集的材料集相加),否则为空。
用 `WHERE collection = 'A'` 选出一个合集,或者对 `meta/vocabulary.json` 中该合集列出的每个活动用 `tools/fetch.py --tag campaign:<name>` 取出它的材料集(它列出的语料库用 `--source` 取)。
其余每一列都从它旁边写明的卡片字段投影而来;
`cards/<source>.yaml` 记录每个值的依据。
卡片字段名在含义相同时沿用语料库卡片格式的字段名;
第三列给出每一列对应的语料库卡片字段,便于两种格式互相对照。
卡片使用 `card_version` 5。
| 列 | cards/<source>.yaml 中的字段 | 语料库卡片字段 | 如何填写 | 取值 | 含义 |
|---|---|---|---|---|---|
| `source` | `source` | `source` | 从索引计数 | 文本 | 来源名称;目录的键,也是它在 data/ 下的文件夹名。 |
| `title` | `title` | 无(只有本格式有) | 来源声明, 评审 | 文本 | 来源的显示名称。 |
| `status` | `status` | `status` | 固定规则, 评审 | `ok`, `flagged` | 来源的卡片的处理状态:ok,或带原因的 flagged;上游对读过的抽样行一个也不提供的来源(fetch 级别为 none)也标为 flagged,以这次读数为原因,不能直接使用。 |
| `status_reasons` | `status_reasons` | `status_reasons` | 固定规则, 评审 | 文本列表 | 卡片被标记的原因;ok 时为空。 |
| `description` | `description` | 无(只有本格式有) | 来源声明, 评审 | 文本 | 来源自己描述的前几句。 |
| `kind` | 无:从该来源在 meta/sources.json 中的条目计数 | 无(只有本格式有) | 固定规则 | `corpus`, `material_set` | 来源的种类:corpus(语料库,原始),采集器持续整批读取的一个完整上游,按行计数,每行指向一个文件或一条记录;或 material_set(材料集,任务就绪),为构建任务从一个来源收录的单元,按单元计数(`unit_id`)。一个来源含有合集的行(它在 meta/sources.json 中的条目写有活动或扩展它的合集),或者它的单元比文件少,就是 material_set;其余来源都是 corpus。规则与数据页相同。 |
| `collection` | 无:从该来源在 meta/sources.json 中的条目计数 | 无(只有本格式有) | 固定规则 | 文本 | 材料集所属合集的代码(catalog/domains.yaml 的 collections,admit_collections.tsv 每行一个;每个代码及其名称见 meta/vocabulary.json),从它的活动批次查出,且只在材料集满足该合集定义所收录的内容时才保留(catalog/domains.yaml 中它的 admits,例如 A 要求单元文件都是电子表格);对语料库,是在 catalog/domains.yaml 的 corpora 下列出它的合集(该语料库装的是这个合集那一类材料),否则为空。材料集是任务材料;语料库是另一层,从不与它相加。 |
| `domain` | 无:来自目录规则(见它的含义) | 无(只有本格式有) | 固定规则 | 文本列表 | 来源的领域代码,权重大的在前:一个顶级领域代码(如 D1)或它下面的叶子(如 D1.6),或者 multi(内容跨越许多领域)或 unclassified。取自流水线仓库 catalog/rules.tsv 中该来源的默认行,否则取自该来源注册信息(它在 meta/sources.json 中的条目)里的领域,否则为 unclassified;各代码的说明在流水线仓库的 catalog/domains.yaml 中。在 rules.tsv 中有自己一行的批次,它的行沿用该行;本列给出来源的默认值。 |
| `form` | 无:来自目录规则(见它的含义) | 无(只有本格式有) | 固定规则 | 文本 | 来源材料的形式,一个标识,如 test-suites 或 tickets:取自流水线仓库 catalog/rules.tsv 的同一行,否则取自来源的注册信息;两者都没有时为空。各形式的说明在流水线仓库的 catalog/domains.yaml 中。 |
| `license` | `license.tier` | `license.tier` | 固定规则, 来源声明, 评审 | `permissive`, `share-alike`, `nc-research`, `internal-only`, `unknown`, `no-training`, `mixed` | 许可证:spdx(SPDX 表达式)、tier(见等级说明)、reason(原因码:决定等级的许可证在 ScanCode LicenseDB 中的类别,小写并以连字符连接;或覆盖表中的码,如 us-pd;或来源自身的条款:terms-of-use、robots、all-rights-reserved;表达式无法解析或其中的许可证两张表都没有时为 unrecognized)、note(来源许可证声明的前几句;完整声明在卡片上)、ship(文件能否随附分发)。 |
| `contamination` | 无:按 tools/fetch.py 默认配置的规则,从 meta/bench_overlap.parquet 和 meta/bench_checked.parquet 算出 | `label.contamination.level` | 从索引计数 | `none`, `benchmark_copy`, `task_file`, `data_address`, `not scanned` | 与基准测试的重叠,按 `tools/fetch.py` 默认配置的规则在 `meta/bench_overlap.parquet` 和 `meta/bench_checked.parquet` 上算出:来源的每个数据文件都已比对并默认保留、且该配置不去掉它的任何行时,等级为 `none`;去掉其中一些行时,等级为去掉行数最多的命中类别,并给出这些行匹配的基准测试(benchmark)、`row` 或 `container`(scope)以及去掉的行数和整个分组数(evidence;分组即行列 collection);其他情况为 `not scanned`。 |
| `pii` | `risk.pii` | `label.pii.level` | 固定规则, 从样本判读, 评审 | `none_known`, `suspected`, `present` | 从样本读出的个人信息:等级和依据;判读之前为空。 |
| `files` | `size.files` | `size.files` | 从索引计数 | 整数 | 文件数:本次发布中该来源的行(指针)数,每行是一个文件或一条记录;材料集的文件包括它的单元的文件和索引为它写的 README.md 与 LICENSE。语料库按这些行计数。 |
| `units` | 无:从该来源在 meta/sources.json 中的条目计数 | 无(只有本格式有) | 从索引计数 | 整数 | 材料集的单元数,即不同 `unit_id` 值的个数:它的各行共用的 unit_group 值(一个测试用例、一个工作簿、一个软件包;材料集的 README.md 和 LICENSE 不算单元)。语料库按行计数,本列给出与 files 相同的数。单元尚未计数的材料集为空。 |
| `publishers` | 无:从本次发布的数据文件的各行计数 | 无(只有本格式有) | 从索引计数 | 整数 | 一个材料集的发布方数:其所有行的 pool_fields 中不同发布方名称的个数(extra.source_meta.pool_fields,即池清单中该单元的一行),从不计上游地址。语料库和各行都没有发布方的材料集为空。 |
| `license_counts` | 无:从本次发布的数据文件的各行计数 | 无(只有本格式有) | 从索引计数 | 对象列表 | 一个材料集的文件按文件种类和许可证计数:每种文件(upstream 为其上游文件;index 为索引为它在 campaign_files/ 下写的文件,即它的 README.md、LICENSE 和软件包文件)、许可证(spdx)以及训练和再分发许可(training_ok、redistribution_ok:yes、conditional、no 或 unknown)的组合各一项,附文件数(files);没有自己许可证的行取其批次的许可证。一个材料集各项之和等于它的文件数。语料库为空。 |
| `language` | 无:从该来源在 meta/sources.json 中的条目计数 | 无(只有本格式有) | 从索引计数 | 文本 | 各行的语言:它们标签中的语言代码(extra.source_meta.language,否则 extra.source_meta.labels.language;也就是 tools/fetch.py 默认配置据以筛选的标签,保留英语、zxx 和没有代码的行),混合时附占比;标签中没有代码的行为 `not recorded`。 |
| `bytes` | `size.bytes` | `size.bytes` | 从索引计数 | 整数 | 引用的大小:有大小的各行 size_bytes 之和,每行算一次(被多行指向的内容按行重复计算);没有一行有大小时为空。 |
| `distinct_bytes` | 无:从该来源在 meta/sources.json 中的条目计数 | 无(只有本格式有) | 从索引计数 | 整数 | 去重后内容:bytes 减去该来源中与另一行内容重复的行的大小(哈希相同,只保留一份,留在按注册顺序排在最前的来源中);没有一行有大小、或本次发布没有记录这类大小时为空。 |
| `size_check` | 无:从 meta/sizes.parquet 中的读数算出 | 无(只有本格式有) | 从索引计数 | 整数对象 | 对记录大小的核对:rows 为该来源在 `meta/sizes.parquet` 中读过的行数;compared 为其中比对了大小或哈希的行数(match、size_mismatch、hash_mismatch),核对的比例以它为分母;以及其中各状态(match、size_mismatch、hash_mismatch、unreachable、gone、needs_auth、no_length、error)的行数。 |
| `fetch_check` | 无:从 meta/sizes.parquet 中的读数算出 | 无(只有本格式有) | 从索引计数 | 对象 | 上游是否仍提供该来源的文件,依据 `meta/sizes.parquet` 中的同一组读数:rows 为读过的抽样行数;fetched 为其中取到且大小和哈希与记录一致的行数(状态 match;不是所记录文件的字节,例如代替工作簿返回的 HTML 页面,大小或 sha256 不同,算作没有取到);read_at 为最近一次读取的日期(UTC);level 在读过的行全部取到时为 `all`,部分取到时为 `some`,一行都没有取到时为 `none`,没有读数时为 `not read`。无论等级如何,来源都留在列表中;数据页、它的卡片和 docs/sources.zh.md 都显示这个读数,`tools/fetch.py` 则在所读发布当天或之后的读数发现有行没有取到时,在下载之前点出这个来源。 |
| `unsized_rows` | 无:从该来源在 meta/sources.json 中的条目计数 | 无(只有本格式有) | 从索引计数 | 整数 | 没有记录大小的行数。 |
| `unsized_estimate` | 无:从 meta/sizes.parquet 中的读数算出 | 无(只有本格式有) | 从索引计数 | 整数对象 | 没有记录大小的行的估计大小:bytes 为 unsized_rows 乘以读过的这类行(状态 match)的平均实测大小,low 和 high 为它的 95% BCa 自助法范围(scipy.stats.bootstrap),readings 为它所依据的读过的行数;读过的这类行少于 10 行时为空。 |
| `unit` | `unit.units` | 无(只有本格式有) | 从索引计数 | 文本 | 一行指向什么(文件、存档成员、网页存档记录、字节范围、API 响应),混合时附占比;材料集则为它的单元数和文件数,与 units 和 files 两列的计数相同。 |
| `top_types` | `form.by_ext` | 无(只有本格式有) | 从索引计数 | 文本列表 | 最常见的文件扩展名,按行数排序。 |
| `needs_auth` | `access.needs_auth` | 无(只有本格式有) | 从索引计数 | 文本 | 下载是否需要登录:no、写明需要什么的值,或 mixed。 |
| `data_files` | 无:从本次发布的数据文件中各行的 source 和 batch 列列出 | 无(只有本格式有) | 从索引计数 | 文本列表 | 存放该来源各行的数据文件在本仓库中的路径,已排序。只从这些文件读取该来源的行(`tools/fetch.py` 就是这样做的):读一次本目录,再每个文件读一次,不列出 `data/`,因为列出文件夹的请求也计入 Hub 的速率限制。 |
| `batch_files` | 无:从本次发布的数据文件中各行的 source 和 batch 列列出 | 无(只有本格式有) | 从索引计数 | 对象列表 | 该来源的每个批次与存放它的行的一个数据文件(batch、file),按批次和文件排序;一个批次分在几个文件里时,每个文件一项。`tools/fetch.py --tag` 只读带有这些标签的批次所在的文件。每一项还给出该来源在这个文件里的第一行和最后一行(first、last,从 0 数起),只读一个来源时只读这一段行。 |
| `released_in` | 无:取自本次发布的记录集 | 无(只有本格式有) | 从索引计数 | 文本 | 该来源的行所来自的那次发布的标签:每个来源在自己的一次运行里构建和检查,一次发布采用它通过了全部检查的最新记录。 |
| `held_back` | 无:取自本次发布的记录集 | 无(只有本格式有) | 从索引计数 | 文本 | 该来源较新的批次被暂缓发布的原因,用发布说明里的话(它的记录没有通过的检查,或本次发布的发现);在较新的批次通过之前,该来源保留它通过了全部检查的最新版本。 |
## 基准测试重叠类别
与基准测试清单比对过的行中,与公开基准测试任务的文件或地址相符的,以及地址位于基准测试清单列出的某个 GitHub 代码仓库或其某个分叉中的,都列在 `meta/bench_overlap.parquet` 中,`hit_class` 给出它的类别。类别由流水线仓库的重叠扫描(`02_scripts/bench_overlap.py` 和 `02_scripts/tb_overlap.py`)判定,下表从这段代码写出,其中的阈值和清单也取自它。`tools/fetch.py` 的默认配置去掉 `benchmark_copy`, `task_file`, `data_address` 这几类的行,其他类别的行只做记录,予以保留。每个键都是精确比对:整个文件字节的哈希、规范化后的地址、镜像引用,以及 zip 成员的大小和 CRC32;所以转换成另一种格式(另一种文件类型、编码或压缩)的文件字节不同,只能凭它保留下来的地址找到。
| 类别 | 默认配置 | 含义 | 如何判定 | 比对的键 | 转换成另一种格式的文件 |
|---|---|---|---|---|---|
| `benchmark_copy` | 去掉 | 该行所在的容器(一个数据集、仓库或软件包:指针标识的前两段)是一份基准测试的副本:它含有同一个基准测试至少 5 道不同题目的文件,或者它派生自某个基准测试。 | 由 task_file 提升而来:按来源、容器和基准测试统计命中的题目(一个文件含多道题时每道题都计入),不同题目达到 5 道及以上时,该容器中除弱匹配外的每个命中行都记为 benchmark_copy;扫描的名称裁定认定派生自基准测试的容器整个计入。网页存档和抓取类来源的容器从不提升。 | 与 task_file 相同;派生容器按其名称。 | 与 task_file 一样,按内容找不到;派生容器按名称找到,与其文件的格式无关。 |
| `task_file` | 去掉 | 该行与某个基准测试题目的一个文件相同,且该文件不是平凡文件(超过 64 字节、不是通用文本、不是软件包),或者该行是题目元数据中点名的题目自己的评测镜像。 | trivial_small、generic_text 和 third_party_package 都不认领的哈希命中;镜像命中中,题目元数据点名、且不是官方 library 镜像(`docker.io/library/`)的镜像。 | 整个文件的 sha256、sha1 和 md5(只知道 Git LFS 指针的文件只有 sha256);镜像为其规范化后的引用。 | 找不到:字节不同,哈希也不同。 |
| `data_address` | 去掉 | 该行的地址是某个基准测试题目为其数据给出的地址:题目文件中的下载或引用地址、题目据以构建的上游拉取请求或议题、题目语料的地址,或评测集清单给出的地址;或者该行的地址位于基准测试清单列出的某个 GitHub 代码仓库中,或位于它的某个分叉中(分叉的分叉也算)。 | reference_or_namespace 和 build_dependency 都不认领的地址命中;来自题目的上游拉取请求或议题、语料或评测集清单字段的地址一律归入此类;`uri`、`alt_uris` 或 `origin.url` 位于这样的代码仓库或分叉中(`github.com`, `raw.githubusercontent.com`, `codeload.github.com`, `media.githubusercontent.com/media`, `api.github.com/repos` 之后接它的所有者和名称)的行也一律归入此类,列出该代码仓库的每个基准测试各计一次。分叉在每次发布时通过 GitHub 的 REST API 列出。 | 规范化后的地址(`tb_overlap.norm_url`);代码仓库按地址中的所有者和名称比对,不分大小写。 | 只要该行保留同一个地址就能找到:比对的是地址,不是字节。 |
| `third_party_package` | 保留 | 题目内置的公共软件包:同一个发行文件。 | 哈希命中中,题目文件是软件包发行文件(`.whl`, `.egg`, `.conda`, `.tar.bz2`, `.jar`, `.gem`, `.crate`, `.nupkg`, `.deb`, `.rpm`)或位于 `wheels/` 文件夹下的。 | 整个文件的 sha256、sha1 和 md5。 | 找不到:字节不同,哈希也不同。 |
| `build_dependency` | 保留 | 题目构建时所用依赖的下载地址:锁文件或 requirements 文件中的软件包地址,或从软件包仓库的下载。 | 地址命中中,题目文件名匹配 `(^\|[-_.])lock([-_.]\|$)\|^requirements.*\.txt$\|^pnpm-lock\.yaml$\|^yarn\.lock$\|^go\.sum$`,或主机是软件包仓库(`registry.npmjs.org`, `registry.yarnpkg.com`, `files.pythonhosted.org`, `static.crates.io`, `proxy.golang.org`, `repo.maven.apache.org`, `repo1.maven.org`, `rubygems.org`)的。 | 规范化后的地址(`tb_overlap.norm_url`)。 | 只要该行保留同一个地址就能找到。 |
| `base_image` | 保留 | 题目构建所基于的容器镜像,名称和标签相同。 | 来自 Dockerfile 的 `FROM` 或 compose 文件的 `image` 的镜像命中,或题目元数据点名的官方 library 镜像。 | 规范化后的镜像引用(名称和标签)。 | 只按名称和标签比对,与其文件的格式无关。 |
| `generic_text` | 保留 | 许多仓库都带有同一份的通用文本:许可证、`.gitignore` 一类。 | 哈希命中中,题目文件名匹配 `^(license\|licence\|copying\|notice\|authors)([._-].*)?$\|^\.(gitignore\|gitkeep\|keep\|dockerignore\|gitattributes)$` 或以 license 开头、题目文件位于 `LICENSES/` 文件夹下,或我们自己的文件名属于这一类的。 | 整个文件的 sha256、sha1 和 md5。 | 找不到:字节不同,哈希也不同。 |
| `trivial_small` | 保留 | 极小的文件(不超过 64 字节),内容平凡,校验值相同并不说明来源相同。 | 题目文件不超过 64 字节的哈希命中,先于哈希命中的其他所有规则判定。 | 整个文件的 sha256、sha1 和 md5。 | 找不到:字节不同,哈希也不同。 |
| `reference_or_namespace` | 保留 | 命名空间或文献引用地址,不是下载地址。 | 主机是 `arxiv.org`, `creativecommons.org`, `doi.org`, `dx.doi.org`, `gnu.org`, `json-schema.org`, `ogp.me`, `opensource.org`, `purl.org`, `rdfs.org`, `schema.org`, `w3.org`, `xmlns.com` 之一或其子域名,或路径以 `/licenses/` 开头的地址命中。 | 规范化后的地址(`tb_overlap.norm_url`)。 | 只要该行保留同一个地址就能找到。 |
| `weak_size_crc32` | 保留 | 弱匹配,与上面各类别分开列出:zip 成员的大小和 CRC32 与某个题目文件相同。它从不被去掉,也从不提升为 benchmark_copy。 | 超过 64 字节的 zip 成员,其大小和 CRC32(从 zip 目录读出,不取回成员本身)与某个题目文件相同。 | 大小和 CRC32。 | 找不到:字节不同,CRC32 和大小也不同。 |
## 实测大小
`meta/sizes.parquet` 的列(每个实测的行一行)。
行里记录的大小大多是上游服务报告的,也有些行没有记录大小。
这个文件存放对其中一个样本的实测:每个数据文件中一组固定的行,按行地址与文件 sha256 的哈希抽取,所以同一个文件抽出的行总是相同。
不超过 64 MiB 的样本行会被下载,核对它记录的大小和每个记录的哈希,然后删除;
更大的行,或者没有记录大小的行,只向服务器询问文件的长度而不取内容:发一个只取第一个字节的 `GET` 请求(`Range: bytes=0-0`),取其 `Content-Range` 中的完整长度(服务器返回整个文件时取其 `Content-Length`,不读内容);
空文件没有第一个字节,应答 `416`,其 `Content-Range` 给出长度 0。
应答没有给出长度的行,或者没有可以询问的地址的行,为 `no_length`。
与行本身无关的失败(HTTP 429 或 5xx,或者完全没有应答)一天后重新实测,连续多次失败后间隔越来越长。
上游应答 HTTP 404 或 410 的行为 `gone`:上游已不再有该文件。
文件在索引仓库中的行(`campaign_files/...`)从实测的提交读取。
还没有实测的数据文件在这里没有行。
| 列 | 类型 | 取值 | 含义 |
|---|---|---|---|
| `source` | 文本 | | 被实测的行所属来源的名称。 |
| `batch` | 文本 | | 被实测的行所属的批次。 |
| `file` | 文本 | | 该行的数据文件在本仓库中的路径(data/ 下的一个 Parquet 文件;meta/catalog.parquet 列出每个来源的文件)。 |
| `file_sha256` | 文本 | | 该数据文件的 sha256;字节不同的文件会重新实测。 |
| `row_key` | 文本 | | 行的地址:uri,是字节范围时接 @range_offset,是容器成员时接 !/member_path。 |
| `recorded_size_bytes` | 整数 | | 行发布时的 size_bytes;行没有记录大小时为空。 |
| `measured_size_bytes` | 整数 | | 这次实测的大小:下载到的字节数(fetched),或从归档中读出的成员自身的字节数(member),或服务器应答的长度(info;较早的实测为 range、content_length),或数出的应答字节数(counted,较早的实测);没有得到长度时为空。 |
| `method` | 文本 | `member`, `fetched`, `info`, `range`, `content_length`, `counted` | 实测方式:member(归档中的成员,由公开取数工具从归档中读出并按其自身大小和 CRC32 核对),fetched(整个下载并核对;取自 API 应答、网页区域或镜像仓库清单的内容总是这样),info(服务器不发内容而应答的长度:只取第一个字节的 GET 请求的 Content-Range 中的完整长度,服务器返回整个文件时则取该 GET 的 Content-Length,不读其内容;空文件没有第一个字节,应答 416,其 Content-Range 给出长度 0)。在 info 之前的实测还有:range(Range: bytes=0-0 请求的 Content-Range 中的完整长度),content_length(服务器返回整个文件时的 Content-Length),counted(应答没有完整长度时数出的字节数,最多数到 64 MiB)。 |
| `hash_checked` | 真或假 | | 是否用下载到的字节核对了记录的哈希。 |
| `hash_ok` | 真或假 | | 核对的哈希是否一致;没有核对时为空。 |
| `status` | 文本 | `match`, `size_mismatch`, `hash_mismatch`, `unreachable`, `gone`, `needs_auth`, `no_length`, `error` | match(实测大小等于记录的大小,或行没有记录大小而测到了大小)、size_mismatch、hash_mismatch、unreachable(没有地址应答)、gone(上游已不再有该文件:HTTP 404 或 410,或来源已标明文件被删除)、needs_auth(需要登录或申请访问)、no_length(没有测到长度:服务器的应答没有给出长度,行没有可以询问的地址,或归档中的成员超过 64 MiB)、error(其他失败;reason 说明是什么)。 |
| `http_status` | 整数 | | 最后一次应答的 HTTP 状态码(有应答时)。 |
| `reason` | 文本 | | 出了什么问题的文字说明;match 时为空。 |
| `measured_at` | 时间(UTC) | | 该行实测的时间。 |
|