模型卡片
什么是模型卡片
模型卡片（Model Card）是模型的附带文件，是一个带有元数据的Markdown文件，该文件头部的YAML部分包含模型的元数据。模型卡片涵盖了关键的模型信息，主要通过渲染模型文件中的README.md获得。其有助于帮助用户理解和正确使用模型，建议您根据规范撰写模型卡片。
模型卡片应涵盖哪些信息
模型卡片应包含如下内容：
- 模型名称
- 模型概述： 包括模型特征和结构
- 使用方式： 尽可能提供详细范例和代码说明模型的使用方式，对模型运行环境，如何进行模型推理及调优做出介绍和解释
- 适用场景： 介绍模型的目标场景、预期用途和潜在的限制
- 训练数据： 说明使用了哪些数据集和训练参数
- 训练流程： 模型训练的具体过程
- 模型评估结果： 展示模型的性能评估结果
模型卡片元数据
模型卡片是由YAML元数据和Markdown文本内容组成。您可以通过编辑README.md文件的头部YAML信息来添加元数据，用“---”进行分隔。Markdown文本展示了模型信息和相关说明。
您可以参考以下模版撰写您的模型卡片。
---
# 许可证
license: apache-2.0
# 用户自定义标签
tags:
- image-classification
- customize tags
---
<!--- 以上为YAML格式，提供许可证和任务描述--->
<!--- 以下为markdown格式的模型描述--->
# 模型名称
介绍模型的概要信息
## 模型详情
### 模型描述
对模型进行描述，包括开发者，模型的类型，框架，相关的语言，许可证说明等内容。
## 用途
### 使用方法
介绍模型的使用方法
## 风险和局限性
介绍模型存在的风险和局限性
### 建议
给用户的建议
## 如何开始使用模型
介绍如何开始使用模型
## 训练详情
### 训练数据
介绍模型的训练数据
### 训练流程
介绍模型的训练过程
## 评估
### 测试数据、因素和指标
#### 测试数据
介绍使用的测试数据
#### 因素
介绍测试相关的环境及条件
#### 指标
介绍测试模型使用的指标
### 结果
#### 结果概要
介绍模型测试结果
已支持的模型标签
| 任务（英文） | 任务（中文） |
|---|---|
| image-classification | 单标签图像分类 |
| image-segmentation | 通用图像分割 |
| ocr | 通用字符文字识别 |
| skin-retouching | 人像美肤 |
| image-to-image | 图生图 |
| video-detection | 视频检测 |
| video-segmentation | 视频分割 |
| video-generation | 视频生成 |
| video-captioning | 视频到文本生成 |
| face-detection | 人脸检测 |
| face-recognition | 人脸识别 |
| face-image-generation | 人脸生成 |
| image-object-detection | 通用目标检测 |
| image-super-resolution | 图像超分辨 |
| action-detection | 行为检测 |
| semantic-segmentation | 语义分割 |
| word-segmentation | 分词 |
| named-entity-recognition | 命名实体识别 |
| part-of-speech | 词性标注 |
| document-segmentation | 文本分割 |
| text-classification | 文本分类 |
| sentiment-classification | 情感分类 |
| nli | 自然语言推理 |
| conversational | 对话 |
| translation | 翻译 |
| text-generation | 文本生成 |
| text-summarization | 文本摘要 |
| feature-extraction | 特征抽取 |
| relation-extraction | 关系抽取 |
| auto-speech-recognition | 语音识别 |
| text-to-speech | 语音合成 |
| audio-classification | 音频分类 |
| text-to-image | 文本生成图片 |
| visual-question-answering | 视觉问答 |
| image-text-retrieval | 图文检索 |