模型卡片（Model Card）

模型卡片是随模型附带、提供实用信息的文件，也是带有附加元数据的 Markdown 文件。

核验日期

定义

模型卡片是随模型附带、提供实用信息的文件。模型卡片是带有附加元数据的 Markdown 文件。模型仓库会把其 README.md 渲染为模型卡片。

模型卡片是一个 Markdown 文件，顶部有一个包含模型元数据的 YAML 部分。Hub 文档称，模型卡片对于可发现性、可复现性和分享是必不可少的。

一图看懂

如何填写模型卡片的每个部分，在 Annotated Model Card 中有说明。

  • 可以使用元数据界面为模型卡片添加元数据。
  • 要进入元数据界面，请前往模型页面，点击模型卡片右上角的 Edit model card 按钮。
  • 也可以直接编辑 README.md 文件的 YAML 部分。
  • 如果要添加界面不支持的元数据，可以直接编辑 README.md 文件的 YAML 部分。
  • 许多与 Hub 集成的库会在上传模型时自动向模型卡片添加元数据。
  • 添加到模型卡片中的元数据有助于发现模型，并使模型更易于使用。
  • 在元数据中添加数据集，会在模型页面上增加“Datasets used to train:”消息，并在数据集可在 Hub 上获取时链接到相关数据集。
  • 如果模型卡片包含指向论文页面的链接，Hugging Face Hub 会提取 arXiv 编号并将其加入模型标签。

原文没有明确这些要点的先后顺序，因此按要点列出，不画先后箭头。

工作原理

可以在模型卡片的元数据部分指定所支持的库。如果没有指定库，Hub 会尝试自动检测库的类型。过去，如果没有检测到任何结果且存在 config.json 文件，就会假定该库是 transformers。

如果模型是微调模型、适配器或某个基础模型的量化版本，可以在模型卡片的元数据部分指定基础模型。基础模型信息也可用来表明模型是多个现有模型的合并。基础模型元数据会用于在模型页面上显示基础模型。

Hub 会推断当前模型与基础模型之间的关系类型。如果模型在 Hub 中有新版本，可以在 new_version 字段中指定它，该元数据会在模型页面上显示指向最新版本的链接。可以在元数据部分指定训练模型所用的数据集，这些数据集会显示在模型页面上，用户可以按数据集筛选模型。

可以在元数据部分指定与模型关联的存储桶，这些存储桶会在模型页面上显示为标签，被关联的存储桶页面也会反过来显示该模型。

例子

pipeline_tag 表示模型所针对的任务类型，同时也用于决定模型使用哪个小组件以及底层使用哪些 API。对于 transformers 模型，pipeline 标签会自动推断，必要时可以在模型卡片元数据中覆盖它。可以在元数据部分指定许可证，许可证会显示在模型页面上，用户可以按许可证筛选模型。

如有需要，也可以把许可证值设为 other，并在元数据中指定名称和许可证链接，从而指定自定义许可证。可以在模型卡片元数据中以结构化方式指定模型的评估结果，这些结果由 Hub 解析并显示在模型页面的小组件中。可以把自定义标签添加到模型卡片元数据的 tags 字段中。

可以在模型卡片元数据中添加 not-for-all-audiences 标签。Hub 使用 KaTeX 数学排版库，在解析 Markdown 之前于服务器端渲染数学公式。

来源

本页内容整理自以下官方来源，点击可核对原文。

核验日期 ·

本页由 AI 依据上述官方来源整理，并经自动核对，未经本站实测。 发现错误？告诉我们。