README.md

# 模型名称(此处需修改，用英文全称与简写)
## 模型介绍
此处填写模型介绍。
## 模型结构
此处简要介绍模型结构。
## 数据集
此处介绍使用的数据集

如添加了自己写的数据集处理脚本，在此处说明脚本的使用方法：

    python xxx.py \
        --args0 xxx \
        --args1 xxx  \
        ...
## 训练及推理
### 环境配置
提供[光源](https://www.sourcefind.cn/#/service-details)拉取的训练以及推理的docker镜像：
* 训练镜像：
* 推理镜像：
### 训练与Fine-tunning
训练命令：

    python train.py \
        --args0 xxx \
        --args1 xxx  \
        ...

Fine-tunning命令：

    python train.py \
        --args0 xxx \
        --args1 xxx  \
        ...
### 预训练模型
model文件夹提供的预训练模型介绍，例如：

    Project
    ├── model
    │   ├── xxx.pth #pytorch预训练模型 
    │   ├── xxx.onnx #对应的onnx模型
    └── └── xxx.mxr #对应的migraphx离线推理模型
### 测试
测试命令：

    python test.py \
        --args0 xxx \
        --args1 xxx
        ...

### 推理
推理引擎版本：
* ONNXRuntime(DCU版本) >= x.xx.x
* Migraphx(DCU版本) >= x.x.x
#### ORT
基于ORT的推理命令：

    python ORT_infer.py \
        --args0 xxx \
        --args1 xxx \
        ...
#### Migraphx
基于Migraphx的推理命令：

    python Migraphx_infer.py \
        --args0 xxx \
        --args1 xxx \
        ...

## 性能和准确率数据
测试数据：[test data](链接)，使用的加速卡:xxx。

根据模型情况填写表格：
| xxx | xxx | xxx | xxx | xxx |
| :------: | :------: | :------: | :------: |:------: |
| xxx | xxx | xxx | xxx | xxx  |
| xxx | xx | xxx | xxx | xxx |
## 历史版本
* 仓库的https链接
## 参考
* [Reference1](链接)
* [Reference2](链接)
* ......