Skip to content

Commit 68b1af3

Browse files
authored
Merge pull request #676 from wangzhen38/add_player
update contribute.md
2 parents 62b94cf + 4f1dc77 commit 68b1af3

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

doc/contribute.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Tips1: 如果有条件请同步添加英文文档Readme_en.md
4646

4747
Tips2: 文档很重要,文档很重要,文档很重要!重要的事情说三遍
4848

49+
Tips3: 可运行命令部分需要使用```bash格式,可参考MMoE的README命令部分
50+
4951
## 数据
5052

5153
样例数据统一以sample_data命名,在模型目录下面,只支持小样本数据
@@ -91,6 +93,38 @@ yaml的详细配置说明请参考[config.yaml配置说明](https://github.com/P
9193

9294
Tips1: config_bigdata中的数据路径请配置dataset的相对路径,方便一键执行
9395

96+
Tips2: config_bigdata中的模型保存路径请设置为output_model_模型名_all的形式,区别于config中模型保存路径的output_model_模型名
97+
98+
## 将模型信息添加到主页
99+
为了方便用户在主页了解到模型分布情况,需要在主页(包括中文和英文)的支持模型列表添加该模型信息
100+
101+
英文首页参考[Support Model List](https://github.com/PaddlePaddle/PaddleRec#support-model-list)
102+
103+
中文首页参考[中文首页支持模型列表](https://github.com/PaddlePaddle/PaddleRec/blob/master/README_CN.md#%E6%94%AF%E6%8C%81%E6%A8%A1%E5%9E%8B%E5%88%97%E8%A1%A8)
104+
105+
注意:中英文两部分的模型信息顺序须保持一致
106+
107+
## 将模型添加到PaperWithCode
108+
进入[PaperWithCode](https://paperswithcode.com/)
109+
110+
若无账号须要先申请
111+
112+
搜索模型对应论文名称,进入该页面即可添加模型
113+
114+
## 外部开发者列表
115+
如果模型的贡献来自外部开发者,需将该作者信息添加到[外部开发者列表](../contributor.md)
116+
117+
## 添加TIPC
118+
为了方便检测模型的精度变化及运行情况,需要模型添加tipc的配置并支持tipc的脚本运行
119+
120+
添加新的模型需要支持lite_train_lite_infer,lite_train_whole_infer,whole_infer,whole_train_whole_infer四种模式。详细运行方式可以参考[基础训练预测功能测试](https://github.com/PaddlePaddle/PaddleRec/blob/master/test_tipc/doc/test_train_inference_python.md)
121+
122+
tips1:更改test_tipc/prepare.sh脚本,在最后添加自己的模型在四种模式时需要下载的数据集,以及用于全量数据预测时的模型下载链接
123+
124+
tips2:在test_tipc/configs目录下为自己的模型建立子目录,目录中需要有train_infer_python.txt文件以运行测试脚本、以及测试脚本运行时需要用到的独立脚本
125+
126+
PS:模型若需要存放于云端可以联系我们
94127

128+
## 添加AIStudio在线运行示列
95129

96130
## FAQ

0 commit comments

Comments
 (0)