Datasets documentation

创建数据集卡片

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v4.8.4).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

创建数据集卡片

每个数据集都应配有一张数据集卡片,以促进负责任的使用,并告知用户数据集中可能存在的任何偏见。 这一理念受到 Mitchell, 2018 提出的模型卡片(Model Cards)的启发。 数据集卡片帮助用户了解数据集的内容、使用场景、创建方式,以及用户应注意的其他事项。

创建数据集卡片很简单,只需几个步骤即可完成:

  1. 前往您在 Hub 上的数据集仓库,点击 Create Dataset Card 以在您的仓库中创建一个新的 README.md 文件。

  2. 使用 Metadata UI 选择描述您数据集的标签。您可以添加许可证、语言、pretty_name、task_categories、size_categories 以及您认为相关的任何其他标签。这些标签有助于用户在 Hub 上发现和找到您的数据集。

对于一套完整但非必需的标签选项,您还可以参阅 Dataset Card 规范。其中包含一些额外的标签选项,例如 multilinguality 和 language_creators,它们很有用但并非绝对必要。

  1. 点击 Import dataset card template 链接,即可自动创建一个包含所有相关待填字段的模板。请尽可能完善模板中的各个部分。有关卡片各部分应包含内容的详细信息,请参阅 Dataset Card Creation Guide。对于无法填写的字段,您可以输入 [More Information Needed]。

  2. 完成后,将更改提交到 README.md 文件,您就会在仓库中看到已完成的 dataset card。

YAML 还允许您通过定义拆分和/或配置来自定义数据集的加载方式,而无需编写任何代码。

您可以参考 SNLI、CNN/DailyMail 和 Allociné 数据集卡片作为示例,以帮助您入门。

Update on GitHub