Skip to content

Commit 3b416ac

Browse files
authored
Merge pull request #683 from wangzhen38/update_contri
update contribute.md
2 parents 59dc03f + e3a1f97 commit 3b416ac

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/contribute.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,17 @@ tips2:在test_tipc/configs目录下为自己的模型建立子目录,目录
125125

126126
PS:模型若需要存放于云端可以联系我们
127127

128+
## 添加read the docs
129+
进入PaddleRec/doc/source/models,在对应的分类目录中建立模型对应的doc,可根据该模型的README文件修改,具体参考[deepfm](https://github.com/PaddlePaddle/PaddleRec/blob/master/doc/source/models/rank/deepfm.md)
130+
131+
在PaddleRec/doc/source/models目录下的[index.rst](https://github.com/PaddlePaddle/PaddleRec/blob/master/doc/source/models/index.rst)文件中添加对应的模型信息
132+
133+
在PaddleRec/doc/source下面的[README](https://github.com/PaddlePaddle/PaddleRec/tree/master/doc/source)文件中添加模型信息
134+
135+
Tips1:对于模型doc,首行需要保持 模型名字(论文名字) 的格式
136+
137+
Tips2:PR合入后,需要使用官网账号构建一下
138+
128139
## 添加AIStudio在线运行示列
129140

130141
## FAQ

0 commit comments

Comments
 (0)