change template

ModelZooStd.md

@@ -53,9 +53,11 @@
     # 模型描述
     modelDescription=简要描述此模型(尽量50字以内)
     # 应用场景
-    appScenario=推理,训练,OCR,政府,交通,零售,金融,医疗(首先描述推理、训练信息，然后描述算法类别信息，最后描述应用行业信息，多个标签用英文逗号隔开。)
+    appScenario=推理,训练,OCR(首先描述推理、训练信息，然后描述算法类别信息，标签用英文逗号隔开。)
     # 框架类型
     frameType=paddle(说明使用的算法框架, 多个标签用英文逗号隔开。)
+    # 加速卡类型
+    accelerateType=BW1000,K100AI(设备为项目中所运行模型测试所用的加速卡，以帮助用户在光源可快速进行目标选型。)
 ```
 
 * 增加LICENSE（必要），源github无LICENSE则在LICENSE里填：None LICENSE Currently；CONTRIBUTORS.md根据源github有无提供（非必要）。
\ No newline at end of file

README.md

-# 算法名简写（英文简写大写）
+# 模型名称（跟原生模型一致）
 ## 论文
-`此处填写实现本项目的算法论文名称`
-- 此处填写算法论文的在线pdf地址
-## 模型结构
-此处一句话简要介绍模型结构
+`此处填写论文名称`
+- 此处填写论文地址链接
 
-<div align=center>
-    <img src="./doc/xxx.png"/>
-</div>
+如果没有写`暂无`
 
-## 算法原理
-此处一句话简要介绍算法原理
+## 模型简介
+简要介绍模型结构，根据论文或者原生模型介绍内容填写，如果有模型结构或者模型算法图则放图，没有则不放。
 
 <div align=center>
     <img src="./doc/xxx.png"/>
 </div>
 
-## 环境配置
-### 硬件需求
-DCU型号：xxx，节点数量：xxx台，卡数：xxx张。
-### Docker（方法一）
-此处提供[光源](https://sourcefind.cn/#/service-list)拉取docker镜像的地址与使用步骤
-```
-docker pull xxx
-docker run xxx
-```
-### Dockerfile（方法二）
-此处提供dockerfile的使用方法
-```
-docker build --no-cache -t xxx:latest .
-docker run xxx
-```
-### Anaconda（方法三）
-此处提供本地配置、编译的详细步骤，例如：
+## 环境依赖
+- 列举基础环境需求，根据实际情况填写
+
+| 软件 | 版本 |
+| :------: | :------: |
+| DTK | xxx |
+| python | xx |
+| transformers | xx |
+| vllm | xx |
+| paddlepaddle | xx |
+
+推荐使用镜像:
+- `docker_name`和`imageID`根据实际模型情况修改
 
-关于本项目DCU显卡所需的特殊深度学习库可从[光合](https://developer.sourcefind.cn/tool/)开发者社区下载安装。
 ```
-DTK驱动：dtk23.04
-python：python3.8
-paddle:2.4.2
+docker run -it --shm-size 200g --network=host --name `docker_name` --privileged --device=/dev/kfd --device=/dev/dri --device=/dev/mkfd --group-add video --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -u root -v /path/your_code_data/:/path/your_code_data/ -v /opt/hyhal/:/opt/hyhal/:ro `imageID` bash
 ```
-`Tips：以上dtk驱动、python、paddle等DCU相关工具版本需要严格一一对应`
+更多镜像可前往[光源](https://sourcefind.cn/#/service-list)下载使用。
 
-其它非深度学习库参照requirements.txt安装：
+关于本项目DCU显卡所需的特殊深度学习库可从[光合](https://developer.sourcefind.cn/tool/)开发者社区下载安装，其它包参照requirements.txt安装：
 ```
 pip install -r requirements.txt
 ```
-## 数据集
-`此处填写公开数据集名称`
 
-- 此处填写公开数据集在公司内部的下载地址（数据集存放中心为：[SCNet AIDatasets](http://111.11.100.223:58001/ui/aihub/datasets) （非必须），模型用到的各公开数据集请分别填上具体地址。），过小权重文件可打包到项目里。
-- 此处填写公开数据集官网下载地址（必须）。
+## 数据集
+[公开数据集名称](公开数据集官网下载地址，过小文件可打包到项目里。)
 
 此处提供数据预处理脚本的使用方法
 ```
@@ -68,21 +55,58 @@ python xxx.py
     │             ├── xxx.png
     │             └── ...
 ```
+如果没有数据集，写`暂无`
+
 ## 训练
-一般情况下，ModelZoo上的项目提供单机训练的启动方法即可，单机多卡、单机单卡至少提供其一训练方法。
-### 单机多卡
+`单机训练`、`多机训练`方法根据实际情况选择填写即可。
+如果没有训练脚本，则写`暂无`，后面`单机训练`，`多机训练`章节删掉。
+### 单机训练
 ```
 sh xxx.sh # 或python xxx.py
 ```
 
-### 单机单卡
+### 多机训练
 ```
 sh xxx.sh 或python xxx.py
 ```
+
 ## 推理
+推理框架有`transformers`、`vllm`、`SGLang`或者其他推理框架中任意一个即可，`单机单卡`，`单机多卡`章节根据模型大小自行选择即可。
+
+### transformers
+#### 单机推理
+```
+sh xxx.sh # 或python xxx.py
+```
+
+#### 多机推理
+```
+sh xxx.sh 或python xxx.py
+```
+
+### vllm
+#### 单机推理
+```
+sh xxx.sh # 或python xxx.py
+```
+
+#### 多机推理
+```
+sh xxx.sh 或python xxx.py
+```
+
+### SGLang
+#### 单机推理
+```
+sh xxx.sh # 或python xxx.py
+```
+
+#### 多机推理
 ```
 sh xxx.sh 或python xxx.py
 ```
+...
+
 ## result
 此处填算法效果测试图（包括输入、输出）
 
@@ -98,34 +122,23 @@ sh xxx.sh 或python xxx.py
 | :------: | :------: | :------: | :------: |:------: |
 | xxx | xxx | xxx | xxx | xxx  |
 | xxx | xx | xxx | xxx | xxx |
-## 应用场景
-### 算法类别
-参考此分类方法（上传时请去除参考图片），与icon图标类别一致，请勿随意命名：
-<div align=center>
-    <img src="./doc/classes.png"/>
-</div>
-
-超出以上分类的类别命名也可参考此网址中的类别名：https://huggingface.co/
 
+## 算法类别
 `此处填算法类别`
+填写此算法最主要的算法类别，数量为1，与icon图标类别一致，请勿随意命名。
 
-填写此算法最主要的算法类别，数量为1。
-
-### 热点应用行业
-应用行业的填写需要做大量调研，从而为使用者提供专业、全面的推荐，除特殊算法，通常推荐数量>=3。
-
-`此处填应用行业`
 ## 预训练权重
-- 此处填写预训练权重在公司内部的下载地址（预训练权重存放中心为：[SCNet AIModels](http://111.11.100.223:58001/ui/aihub/models) （非必须），模型用到的各预训练权重请分别填上具体地址。），过小权重文件可打包到项目里。
-- 此处填写公开预训练权重官网下载地址（必须）。
+|模型名称  | 权重大小  | DCU型号  | 最低卡数需求 |下载地址，填写公开预训练权重官网下载地址（必须），使用`[下载地址](链接)`格式，样例如下|
+|:-----:|:----------:|:----------:|:----------:|:----------:|
+|Qwen3 | 4B | K100AI,BW1000 | 1 | [下载地址](https://hf-mirror.com/Qwen/Qwen3-4B-Instruct-2507) |
+
 ## 源码仓库及问题反馈
 - 此处填本项目gitlab地址
+
 ## 参考资料
 - 此处填源github地址（方便使用者查看原github issue）
 - 此处填参考项目或教程网址
 - ......
 
-
-
 `关于model.properties（必要）、LICENSE（必要）、CONTRIBUTORS、模型图标（必要）等其它信息提供参照： `[`ModelZooStd.md`](./ModelZooStd.md)
 `各个模型需要保留原项目README.md，改名为README_origin.md即可。`
\ No newline at end of file

model.properties

@@ -5,7 +5,7 @@ modelName=模型名称(同项目名称,模型名_深度学习框架：模型名
 # 模型描述
 modelDescription=简要描述此模型(尽量50字以内)
 # 应用场景
-appScenario=推理,训练,OCR,政府,交通,零售,金融,医疗(首先描述推理、训练信息，然后描述算法类别信息，最后描述应用行业信息，多个标签用英文逗号隔开。)
+appScenario=推理,训练,OCR(首先描述推理、训练信息，然后描述算法类别信息，标签用英文逗号隔开。)
 # 框架类型
 frameType=paddle(说明使用的算法框架, 多个标签用英文逗号隔开。)
 # 加速卡类型