ModelZooStd.md 2.39 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
V2.0  
chenych committed
6
    │   ├── filename_1
chenzk's avatar
v1.0  
chenzk committed
7
8
9
    │             ├── xxx.png
    │             ├── xxx.png
    │             └── ...
chenych's avatar
V2.0  
chenych committed
10
    │   └── filename_2
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
17
    ├── doc
    │   ├── icon.png
    │   ├── xxx.png
    │   └── xxx.png
liuhy's avatar
liuhy committed
18
19
20
21
22
23
24
25
26
27
    ├── README.md
    ├── requirement.txt
    ├── model.properties
    ├── code_file1.py
    ├── code_file2.py
    ├── code_file3.py
    ├── dirs
    │   ├── code_file4.py
    │   ├── code_file5.py
    └── └── code_file6.py
chenzk's avatar
v1.0  
chenzk committed
28
```
chenzk's avatar
chenzk committed
29

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

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

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

chenzk's avatar
v1.0  
chenzk committed
42
43
44
45
* model.properties:`五大属性`固定模板如下:
```
    # 模型唯一标识
    modelCode=Project ID
46
    # 模型名称
chenych's avatar
V2.0  
chenych committed
47
    modelName=模型名称(同项目名称:模型名_深度学习框架,小写)
48
    # 模型描述
liuhy's avatar
liuhy committed
49
    modelDescription=简要描述此模型(尽量50字以内)
50
    # 应用场景
chenych's avatar
V2.0  
chenych committed
51
52
53
    processType=推理,训练
    # 算法类别
    appScenario=代码生成
54
    # 框架类型
chenych's avatar
V2.0  
chenych committed
55
    frameType=pytorch(说明使用的算法框架, 多个标签用英文逗号隔开。)
chenych's avatar
chenych committed
56
57
    # 加速卡类型
    accelerateType=BW1000,K100AI(设备为项目中所运行模型测试所用的加速卡,以帮助用户在光源可快速进行目标选型。)
chenzk's avatar
v1.0  
chenzk committed
58
```
chenzk's avatar
chenzk committed
59

chenzk's avatar
v1.0.5  
chenzk committed
60
* 增加LICENSE(必要),源github无LICENSE则在LICENSE里填:None LICENSE Currently;CONTRIBUTORS.md根据源github有无提供(非必要)。