数据集卡片

什么是数据集卡片？

每个数据集都可以通过仓库中的 README.md 文件进行文档化。该文件被称为 数据集卡片，Hugging Face Hub 会在数据集的主页上渲染其内容。为了告知用户如何负责任地使用数据，建议在卡片中包含有关数据集中任何潜在偏差的信息。通常，数据集卡片有助于用户了解数据集的内容，并提供有关应如何使用该数据集的背景信息。

您还可以在卡片中添加数据集元数据。元数据描述了数据集的重要信息，例如许可证、语言和大小。它还包含标签，以帮助用户在 Hub 上发现数据集，以及 数据文件配置 选项。标签在 README.md 文件顶部的 YAML 元数据部分中定义。

数据集卡片元数据

数据集仓库会将其 README.md 渲染为数据集卡片。为了控制 Hub 如何显示该卡片，您应在 README 文件中创建一个 YAML 部分来定义一些元数据。首先在文件顶部添加三个 ---，然后包含所有相关的元数据，最后再用一组 --- 关闭该部分，如下面的示例所示：

language: 
- "List of ISO 639-1 code for your language"
- lang1
- lang2
pretty_name: "Pretty Name of the Dataset"
tags:
- tag1
- tag2
license: "any valid license identifier"
task_categories:
- task1
- task2

您添加到数据集卡片中的元数据可以启用 Hub 上的某些交互功能。例如：

• 允许用户在 https://huggingface.co/datasets 上筛选和发现数据集。
• 如果您使用此表格右列中列出的关键字选择许可证，该许可证将显示在数据集页面上。

在 Hub 的数据集仓库中创建 README.md 文件时，请使用 Metadata UI 填写主要元数据：

有关元数据字段，请参阅详细的数据集卡片规范。

数据集卡片创建指南

如需了解创建数据集卡片的分步指南，请参阅 创建数据集卡片 指南。

阅读现有的数据集卡片，例如 ELI5 数据集卡片，是熟悉常见约定的一种好方法。

关联论文

如果数据集卡片中包含指向论文页面的链接（无论是 HF 上的还是 Arxiv 摘要/PDF），Hub 将提取 arXiv ID 并以 arxiv:<PAPER ID> 的格式将其包含在数据集标签中。点击该标签可以：

• 访问 Paper 页面
• 筛选 Hub 上引用同一篇论文的其他模型。

阅读有关论文页面的更多信息，请参见此处。

强制设置数据集模态

Hub 会根据数据集包含的文件（音频、视频、地理空间等）自动检测其模态。如果您想强制指定特定模态，可以在数据集卡片的元数据中添加标签：3d、audio、geospatial、image、tabular、text、timeseries、video。

例如，若要强制将模态设置为 audio，请在数据集卡片元数据中添加以下内容：

tags:
- audio

将库关联到数据集

数据集页面会自动显示能够原生加载该数据集的库和工具，但如果您想显示其他特定的库，可以在数据集卡片的元数据中添加标签。支持的标签包括 agentenv、argilla、dask、datasets、distilabel、fiftyone、harbor、mlcroissant、nemo-gym、openenv、pandas、verifiers 和 webdataset。请参阅 支持的库列表 以获取完整列表，或提议添加新的库。

例如，要将 argilla 库关联到数据集卡片，请在数据集卡片的元数据中添加以下内容：

tags:
- argilla

声明一个 RL 环境数据集

RL 环境是一个普通的 dataset 仓库，其文件可被一个或多个环境框架使用。添加 rl-environment 标签，以便通过 RL Environments 过滤器发现该 dataset，然后为每个支持的框架添加一个标签。框架标签还会将其生成的命令添加到 Use this dataset 中。

例如，一个包含 Harbor 任务目录且也可由 Verifiers 加载的数据集，其数据集卡片 YAML 如下：

---
pretty_name: Terminal-Bench 2.0
tags:
- rl-environment
- harbor
- verifiers
---

支持的环境框架标签为：

这些标签用于描述兼容性并生成加载命令。它们不会创建新的仓库类型，也不会导致 Hub 执行该环境。