带注释的模型卡片模板

模板

使用指南

完整填写模型卡片需要来自几个不同角色的输入。（一个人可能担任多个角色。）我们将这些角色称为开发者，他们编写代码并运行训练；社会技术专家，他们擅长长期分析技术与社会的互动（包括律师、伦理学家、社会学家或权利倡导者）；以及项目组织者，他们了解模型的总体范围和影响，可以大致填写卡片的每个部分，并担任模型卡片更新的联系人。

开发者对于填写训练程序和技术规格是必要的。他们对于偏见、风险和局限性的“局限性”部分也特别有用。他们负责为评估提供结果，理想情况下与其他角色合作定义评估的其余部分：测试数据、因素和指标。
社会技术专家对于填写偏见、风险和局限性中的“偏见”和“风险”是必要的，并且对于用途中的“超出范围的使用”特别有用。
项目组织者对于填写模型详情和用途是必要的。他们也可能填写训练数据。项目组织者还可以负责引用、词汇表、模型卡片联系人、模型卡片作者和更多信息。

说明如下，以斜体显示。

模板变量名以等宽字体显示。

模型名称

章节概述： 提供模型名称以及对模型内容的 1-2 句话摘要。

model_id

model_summary

模型详情

章节概述： 本节提供关于模型是什么、其当前状态以及来源的基本信息。对于任何想要引用该模型的人来说，这应该是有用的。

模型描述

model_description

提供关于模型的基本细节。这包括架构、版本、是否在论文中介绍过、是否有原始实现以及创建者。任何版权都应在此处注明。关于训练程序、参数和重要免责声明的一般信息也可以在本节中提及。

开发者： developers

列出（并最好链接到）构建模型的人员。

资助者： funded_by

列出（并最好链接到）在财务、计算或其他方面支持或启用此模型的资金来源。

共享者 [可选]： shared_by

列出（并最好链接到）使模型在线可用的人员/组织。

模型类型： model_type

您可以将“类型”命名为

1. 监督/学习方法

2. 机器学习类型

3. 模态

语言 [NLP]： language

当系统使用或处理自然（人类）语言时，请使用此字段。

许可证： license

命名并链接到正在使用的许可证。

微调自模型 [可选]： base_model

如果此模型有另一个模型作为其基础，请在此处链接到该模型。

模型来源 [可选]

仓库： repo
论文 [可选]： paper
演示 [可选]： demo

提供来源，供用户直接查看模型及其详细信息。其他类型的资源——训练日志、经验教训等——属于更多信息部分。如果您要为此部分添加一项内容，请链接到仓库。

用途

章节概述： 本节解答关于模型在不同应用场景中的预期用途的问题，讨论模型的可预见用户（包括受模型影响的用户），并描述被认为超出范围或误用模型的用途。请注意，本节不旨在包含许可证使用详情。为此，请直接链接到许可证。

直接使用

direct_use

解释如何在不进行微调、后处理或插入管道的情况下使用模型。建议提供示例代码片段。

下游使用 [可选]

downstream_use

解释当针对特定任务进行微调或插入更大的生态系统或应用程序时，如何使用此模型。建议提供示例代码片段。

超出范围的使用

out_of_scope_use

列出模型可能被预见到的误用方式（以模型无法工作的方式使用），并说明用户不应该对模型做什么。

偏见、风险和局限性

章节概述： 本节识别可预见的危害、误解以及技术和社会技术局限性。它还提供关于警告和潜在缓解措施的信息。偏见、风险和局限性有时可能是不可分割的/指代相同的问题。一般来说，偏见和风险是社会技术性的，而局限性是技术性的

偏见是对某些子群体的刻板印象或不成比例的性能（偏差）。
风险是模型可能引起的与社会相关的问题。
局限性是可能发生的故障模式，可以通过遵循列出的建议来解决。

bias_risks_limitations

此模型已知的或可预见的问题是什么？

建议

bias_recommendations

关于可预见的问题，有哪些建议？这可以包括从“下采样图像”到过滤露骨内容的所有内容。

训练详情

章节概述：本节提供信息以描述和复现训练过程，包括训练数据、训练元素的速度和大小以及训练的环境影响。这与技术规范部分也密切相关，当此处内容与训练过程相关时，应链接到该部分。这对于想要了解有关模型输入和训练足迹的更多信息的人很有用。对于任何想要了解模型学习内容基础知识的人来说，这都是相关的。

训练数据

training_data

用 1-2 句话写一下什么是训练数据。理想情况下，这应链接到数据集卡以获取更多信息。与数据预处理或额外过滤相关的文档链接也可以放在此处以及更多信息部分。

训练过程（可选）

预处理

preprocessing

详细说明分词、调整大小/重写（取决于模态）等。

速度、大小、时间

speeds_sizes_times

详细说明吞吐量、开始/结束时间、检查点大小等。

评估

章节概述：本节描述评估协议、评估中衡量的内容，并提供结果。理想情况下，评估至少包含两个部分，一部分着眼于对一般性能的定量测量（测试数据、因素和指标），例如可以通过基准测试完成；另一部分着眼于在特定社会安全问题（社会影响评估）方面的性能，例如可以通过红队测试完成。您还可以在模型卡元数据中以结构化方式指定模型的评估结果。结果由 Hub 解析并在模型页面上的小部件中显示。请参阅 https://huggingface.co/docs/hub/model-cards#evaluation-results。

测试数据、因素和指标

理想情况下，评估应根据不同因素进行分解，例如任务、领域和人口子群体；并使用对于可预见的用例环境最有意义的指标进行计算。不同子群体之间相等的评估性能被认为是跨这些子群体的“公平”；目标公平性指标应根据哪些错误更可能因模型使用而产生问题来决定。然而，本节最常用于报告关于不同任务基准的总体评估性能。

测试数据

testing_data

描述测试数据或链接到其数据集卡。

因素

testing_factors

哪些是可预见的、会影响模型行为的特征？理想情况下，评估应根据这些因素进行分解，以便发现性能差异。

指标

testing_metrics

将使用哪些指标进行评估？

结果

results

结果应基于上面定义的“因素”和“指标”。

摘要

results_summary

结果说明了什么？这可以作为面向普通受众的 tl;dr 版本。

社会影响评估（可选）

使用此自由文本部分来解释如何评估此模型对社会危害的风险，例如儿童安全、NCII、隐私和暴力。这可能采取回答以下问题的形式

此模型对儿童安全吗？为什么安全或不安全？
是否已对此模型进行测试，以评估与非自愿性私密图像（包括 CSEM）相关的风险？
是否已对此模型进行测试，以评估与暴力活动或暴力描述相关的风险？结果如何？

也可以提供每个问题的定量数字。

模型检查（可选）

章节概述：这是一个实验性章节，一些开发人员开始添加，关于可解释性的工作可能会放在这里。

model_examination

环境影响

章节概述：总结了计算环境影响（如用电量和碳排放量）所需的信息。

硬件类型： hardware_type
使用时长： hours_used
云服务提供商： cloud_provider
计算区域： cloud_region
碳排放量： co2_emitted

可以使用机器学习影响计算器估算碳排放量，该计算器在 Lacoste 等人 (2019) 中提出。

技术规范（可选）

章节概述：本节包含有关模型目标和架构以及计算基础设施的详细信息。这对于对模型开发感兴趣的人很有用。编写本节通常需要模型开发人员直接参与。

模型架构和目标

model_specs

计算基础设施

compute_infrastructure

硬件

hardware_requirements

最低硬件要求是什么，例如处理、存储和内存要求？

软件

software

引用（可选）

章节概述：开发人员对此模型的首选引用。这通常是一篇论文。

BibTeX

citation_bibtex

APA

citation_apa

词汇表（可选）

章节概述：本节定义了常用术语以及指标的计算方式。

glossary

清晰地定义术语，以便不同受众都能理解。

模型卡作者（可选）

章节概述：本节列出了创建模型卡的人员，对模型卡构建的详细工作表示认可和责任。

model_card_authors

模型卡联系方式

章节概述：提供了一种方式，供对模型卡有更新、建议或问题的人联系模型卡作者

model_card_contact

如何开始使用模型

章节概述： 提供代码片段以展示如何使用模型。

get_started_code

请引用为： Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook

< > 更新在 GitHub 上

Hub