ModelZooStd.md 2.56 KB
Newer Older
liuhy's avatar
liuhy committed
1
# 仓库目录结构
chenzk's avatar
v1.0  
chenzk committed
2
3
* 除预训练模型外其他文件总大小尽量不要超过50M
```
liuhy's avatar
liuhy committed
4
    Project
chenzk's avatar
v1.0  
chenzk committed
5
    ├── dataset
chenych's avatar
chenych committed
6
    │   ├── filename1
chenzk's avatar
v1.0  
chenzk committed
7
8
9
    │             ├── xxx.png
    │             ├── xxx.png
    │             └── ...
chenych's avatar
chenych committed
10
    │   └── filename2
chenzk's avatar
v1.0  
chenzk committed
11
12
    │             ├── xxx.png
    │             ├── xxx.png
chenych's avatar
chenych committed
13
    │             └── ...
chenzk's avatar
v1.0  
chenzk committed
14
15
16
    ├── doc
    │   ├── xxx.png
    │   └── xxx.png
chenych's avatar
chenych committed
17
    │── icon.png
liuhy's avatar
liuhy committed
18
    ├── README.md
chenych's avatar
chenych committed
19
    ├── requirements.txt
liuhy's avatar
liuhy committed
20
21
    ├── model.properties
    ├── dirs
chenych's avatar
chenych committed
22
23
24
    │   ├── code_file1.py
    │   ├── code_file2.py
    └── └── code_file3.py
chenzk's avatar
v1.0  
chenzk committed
25
```
chenzk's avatar
chenzk committed
26

chenych's avatar
V2.0  
chenych committed
27
* icon.png:模型的图标文件,上传者需放至项目根目录供前端读取,所需算法类别图标可到 [飞书->云文档->云盘->icon](https://r0ddbu55vzx.feishu.cn/drive/folder/AgoUfBk5IlYTV1dBz2YcGSYUnDf) 查找,放入仓库后的图标文件,需要将名称从`类别名称`修改为`icon`,如`OCR.png`修改为`icon.png`
chenzk's avatar
chenzk committed
28
29
![icon](./icon.png)

chenych's avatar
V2.0  
chenych committed
30
* README.md:参照下图。
chenzk's avatar
v1.0  
chenzk committed
31
![img](./doc/readme.png)
chenzk's avatar
chenzk committed
32

chenych's avatar
chenych committed
33
* requirements.txt:模型依赖统一写到此文件,与NV相关的库请注释,以免安装错误。
chenzk's avatar
chenzk committed
34
35
36
37
```
说明:数据基本由公司网盘储存并提供url下载或直接读取,数据信息介绍由超算互联网商城提供,内部无数据时提供官网下载地址。
```
* 需要提供迷你数据集以供使用者快速上手项目。
chenzk's avatar
chenzk committed
38

chenych's avatar
chenych committed
39
* model.properties:
chenzk's avatar
v1.0  
chenzk committed
40
```
chenych's avatar
chenych committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# 模型唯一标识
modelCode=Project ID(GitLab创建项目后查看名称下面的Project ID即可,注意此ID为hpccube下GitLab生成的ID,不可编造。例如:365)
# 模型名称
modelName=模型名称(同项目名称,模型名_深度学习框架:模型名为源github项目名(官方名称),深度学习框架名采用小写格式。例如:Janus_pytorch,resnet50_tensorflow)
# 模型描述
modelDescription=简要描述此模型(尽量50字以内)
# 运行过程
processType=推理,训练(标签用英文逗号隔开。)
# 算法类别
appCategory=OCR(与icon图标名称一致,请勿随意命名, 全部类别请查看:https://r0ddbu55vzx.feishu.cn/drive/folder/AgoUfBk5IlYTV1dBz2YcGSYUnDf)
# 框架类型
frameType=paddle(说明使用的算法框架, 多个标签用英文逗号隔开。)
# 加速卡类型
accelerateType=BW1000,K100AI(设备为项目中所运行模型测试所用的加速卡,以帮助用户在光源可快速进行目标选型。)
chenzk's avatar
v1.0  
chenzk committed
55
```
chenzk's avatar
chenzk committed
56

chenych's avatar
chenych committed
57
* 增加LICENSE(必要),源github无LICENSE则在LICENSE里填:None LICENSE Currently.