模型卡片
本文档将详细说明模型卡片的概念、创建规范、操作方法和维护要求。
模型卡片
模型卡片作为用户了解模型详情的重要入口，通过模型仓库中的 README.md 文件进行管理和展示。它由 YAML 头部元数据和 Markdown 正文内容两部分构成，是用户快速理解、应用和分享模型的重要桥梁。
一个高质量的模型卡片通常应该涵盖以下核心要素：
-
模型基础信息：模型名称、功能描述、技术架构、核心特性等基本介绍。
-
应用场景和使用范围：明确说明模型的适用领域和应用场景，帮助用户判断是否符合需求。
-
使用指南：提供详细的使用说明，包括所需的开发框架、运行环境配置、输入数据格式等。最好能提供可运行的代码示例。
-
训练数据说明：描述模型训练时使用的数据集类型、数据规模、数据预处理方式等。
-
训练过程介绍：阐述模型的训练方法、关键参数设置、优化策略等技术细节。
-
性能评估报告：展示模型在各项指标上的表现，包括准确率、速度等性能数据。
具体的编写要求和格式规范请参考下文的详细说明。
为了帮助社区用户更好地发现、使用和改进开源模型，我们鼓励所有模型发布者按照标准规范来完善模型卡片内容。同时，我们也欢迎社区成员积极参与模型生态建设，您可以在模型页面的讨论区提出改进建议，或者直接通过提交 Pull Request 的方式来优化和完善模型卡片。
编辑模型卡片
如果您是模型创建者，可以点击模型卡片右上角的“编辑模型卡片”按钮，编辑模型的元信息和描述。
元信息（metadata）
元信息表单支持编辑模型的许可证、训练用到的数据集、语言、度量指标、框架和任务类型。
编辑元信息表单后，内容将同步保存到 README.md 顶部的 YAML 元信息信息中。
元信息由 --- 包裹，内容为 YAML 格式:
---
license: mit
language:
- en
- zh
---
描述
描述内容为 Markdown 格式，用于介绍当前模型，关于 Markdown 语法请参考 CommonMark 。