# 模型资产说明文档建议规范
#### 模型资产说明文档简介
模型资产说明文档是资产文件中的README.md文件，用于描述模型资产的详情内容，主要由头部的 YAML 元数据 和 Markdown 正文共两个部分组成，帮助用户能快速了解和使用。
一份完善的模型资产说明文档，建议包括但不限于以下内容：
- 模型名称和简介：介绍模型的基础信息、特点、架构等。
- 模型特性： 介绍模型的输入输出以及目标使用场景。
- 模型约束条件：介绍模型使用的约束条件，使用规格
- 训练数据：介绍使用了怎样的训练数据集或数据格式要求。
- 模型训练：介绍如何训练，使用了怎样的预处理方法、训练参数等。
- 数据评测与结果：介绍模型运行的效果和性能维度。
 
#### YAML头部元数据
模型资产说明文档的元数据由 README.md 文件头部的 YAML 小节维护，并使用 --- 将其与 Markdown 正文分节区隔。元数据主要用于描述与模型相关的基础字段，包括但不限于：开源证书（License）、版本（version）、关联数据集（datasets）及自定义标签（tags）等。
详细的元数据字段介绍及示例可参考以下示例：
```
---
version: v0.0.1
license: Apache License 2.0
tags: # 标签
  - Commercial
  - Skill Model
---
```
#### 模型资产Markdown正文模板
```
# <模型名字>介绍
介绍模型的基本信息。
## 简介
提供模型描述，包括模型结构，使用的训练数据集，以及适用场景等等内容；也可以链接模型的来源，包括代码仓库、论文或DEMO。
## 模型特性
介绍模型的输入输出以及目标使用场景。
### 如何使用
介绍模型如何使用，包括如何进行模型推理、模型微调等信息。在这里希望模型提供者能提供
详尽的范例以及代码片段来介绍模型的使用方法。对于需要配置负责运行环境的模型，
也可以在这里提供如何配置模型运行环境的详细介绍。
如果模型支持微调，在本小节也请介绍微调需要准备的数据集格式及要求。
#### 代码范例
<!--- 请分别提供模型推理、模型微调的代码范例--->
```python
import cv2
from modelscope.pipelines import pipeline
from modelscope.utils.constant import Tasks
from modelscope.pipelines.outputs import OutputKeys
img_matting = pipeline(Tasks.portrait_matting,model='damo/cv_unet_image-matting')
result = img_matting('test.png')
cv2.imwrite('result.png', result[OutputKeys.OUTPUT_IMG])
```
##模型约束条件
介绍模型适用的场景，以及在哪些场景可能存在局限性，以及模型在构造训练过程中，
本身可能带有的，由于训练数据以及训练方法等因素引入的偏向性。
## 模型训练
描述模型是如何具体训练出来的。
### 训练数据介绍
介绍训练数据是如何获取，组织，以及针对模型的需求进行格式化的。
### 预处理
介绍如何对训练数据进行预处理。
### 训练
介绍训练的硬件要求与环境、训练的超参数设置、训练的步骤与流程，并提供必要的训练代码块。
## 数据评测及结果
提供模型在不同数据集上的性能评测，包括评测数据是如何获得的。评测结果本身
可以通过表格，图像等多种方法做展示。
### 相关论文以及引用信息
如果本模型有相关论文发表，或者是基于某些论文的产出物，可以在这里提供Bibtex格式的参考文献。
```