diff --git a/.gitee/PULL_REQUEST_TEMPLATE.md b/.gitee/PULL_REQUEST_TEMPLATE.md index 461682c0555ccb909c304021259918c2fc5b915c..cb027d4b2a7a877eb84b09d9da04948b8fde57e2 100644 --- a/.gitee/PULL_REQUEST_TEMPLATE.md +++ b/.gitee/PULL_REQUEST_TEMPLATE.md @@ -36,7 +36,7 @@ Fixes # - [ ] I have made corresponding changes to the documentation. - [ ] I have squashed all the commits into one. - [ ] I have test and ascertained the effect of my change in all related cases. - - [ ] Different hardware: `CPU`, `GPU`, `Ascend910`, `Ascend310`, `Ascend701`. + - [ ] Different hardware: `CPU`, `GPU`, `Ascend910`, `Ascend310`, `Ascend310P`. - [ ] Different mode: `GRAPH_MODE`, `PYNATIVE_MODE`. - [ ] Different system: `Linux`, `Windows`, `MAC`. - [ ] Different number of cluster: `1pc`, `8pcs`. diff --git a/how_to_contribute/README_TEMPLATE.md b/how_to_contribute/README_TEMPLATE.md index 730463747bd4f0cabd9219eb53cb9afe09db1f04..7e5953866732683d79353c4af0c2fe4adc26f679 100644 --- a/how_to_contribute/README_TEMPLATE.md +++ b/how_to_contribute/README_TEMPLATE.md @@ -1,6 +1,6 @@ -<TOC> +# Content -# Title, Model name +# Model name > The Description of Model. The paper present this model. @@ -8,13 +8,13 @@ > There could be various architecture about some model. Represent the architecture of your implementation. -## Features(optional) +## Dataset -> Represent the distinctive feature you used in the model implementation. Such as distributed auto-parallel or some special training trick. +> Provide the information of the dataset you used. Check the copyrights of the dataset you used, usually you need to provide the hyperlink to download the dataset, scope and data size. -## Dataset +## Features(optional) -> Provide the information of the dataset you used. Check the copyrights of the dataset you used, usually you need to provide the hyperlink to download the dataset. +> Represent the distinctive feature you used in the model implementation. Such as distributed auto-parallel or some special training trick. ## Requirements @@ -28,6 +28,10 @@ ## Quick Start > How to take a try without understanding anything about the model. +> Maybe include锛� +> * run train锛宺un eval锛宺un export +> * Ascend version, GPU version锛孋PU version +> * offline version锛孧odelArts version ## Script Description @@ -35,15 +39,15 @@ ### Scripts and Sample Code -> Explain every file in your project. +> Show the scope of project(include children directory), Explain every file in your project. ### Script Parameter -> Explain every parameter of the model. Especially the parameters in `config.py`. +> Explain every parameter of the model. Especially the parameters in `config.py`. If there are multiple config files, please explain separately. ## Training -> Provide training information. +> Provide training information. Include usage and log. ### Training Process @@ -55,28 +59,57 @@ e.g. Run the following command for distributed training on Ascend. bash run_distribute_train.sh [RANK_TABLE_FILE] [PRETRAINED_MODEL] ``` -### Transfer Training(Optional) - -> Provide the guidelines about how to run transfer training based on an pretrained model. - -### Training Result +> Provide training logs. -> Provide the result of training. +```log +# grep "loss is " train.log +epoch:1 step:390, loss is 1.4842823 +epcoh:2 step:390, loss is 1.0897788 +``` +> Provide training result. e.g. Training checkpoint will be stored in `XXXX/ckpt_0`. You will get result from log file like the following: -``` +```log epoch: 11 step: 7393 ,rpn_loss: 0.02003, rcnn_loss: 0.52051, rpn_cls_loss: 0.01761, rpn_reg_loss: 0.00241, rcnn_cls_loss: 0.16028, rcnn_reg_loss: 0.08411, rcnn_mask_loss: 0.27588, total_loss: 0.54054 epoch: 12 step: 7393 ,rpn_loss: 0.00547, rcnn_loss: 0.39258, rpn_cls_loss: 0.00285, rpn_reg_loss: 0.00262, rcnn_cls_loss: 0.08002, rcnn_reg_loss: 0.04990, rcnn_mask_loss: 0.26245, total_loss: 0.39804 ``` +### Transfer Training(Optional) + +> Provide the guidelines about how to run transfer training based on an pretrained model. + +### Distribute Training + +> Same as Training + ## Evaluation -### Evaluation Process +### Evaluation Process 910 > Provide the use of evaluation scripts. -### Evaluation Result +### Evaluation Result 910 + +> Provide the result of evaluation. + +## Export + +### Export Process + +> Provide the use of export scripts. + +### Export Result + +> Provide the result of export. + +## Evaluation 310 + +### Evaluation Process 310 + +> Provide the use of evaluation scripts. + +### Evaluation Result 310 > Provide the result of evaluation. @@ -134,10 +167,13 @@ e.g. you can reference the following template ## Contributions +This part should not exist in your readme. If you want to contribute, please review the [contribution guidelines](https://gitee.com/mindspore/models/blob/master/CONTRIBUTING.md) and [how_to_contribute](https://gitee.com/mindspore/models/tree/master/how_to_contribute) ### Contributors +Update your school and email/gitee. + * [c34](https://gitee.com/c_34) (Huawei) ## ModeZoo Homepage diff --git a/how_to_contribute/README_TEMPLATE_CN.md b/how_to_contribute/README_TEMPLATE_CN.md index 3d160f1e32f5d59e49e3baf7504f1e6bf109b553..ae5daac27423ea13c2435a242154679f518c31dd 100644 --- a/how_to_contribute/README_TEMPLATE_CN.md +++ b/how_to_contribute/README_TEMPLATE_CN.md @@ -1,16 +1,20 @@ -<TOC> +# 鐩綍 -# 鏍囬锛� 妯″瀷鍚嶇О +# 妯″瀷鍚嶇О -> 鍙互鏄ā鍨嬬殑涓嶅悓鏋舵瀯锛屽悕绉板彲浠ヤ唬琛ㄤ綘鎵€瀹炵幇鐨勬ā鍨嬫灦鏋� +> 妯″瀷绠€浠嬶紝璁烘枃妯″瀷姒傛嫭 -## 鐗规€э紙鍙€夛級 +## 妯″瀷鏋舵瀯 -> 灞曠ず浣犲湪妯″瀷瀹炵幇涓娇鐢ㄧ殑鐗规€э紝渚嬪鍒嗗竷寮忚嚜鍔ㄥ苟琛屾垨鑰呬竴浜涚壒娈婄殑璁粌鎶€宸� +> 濡傚寘鍚绉嶆ā鍨嬫灦鏋勶紝灞曠ず浣犲疄鐜扮殑閮ㄥ垎 ## 鏁版嵁闆� -> 鎻愪緵浣犳墍浣跨敤鐨勬暟鎹俊鎭紝妫€鏌ユ暟鎹増鏉冿紝閫氬父鎯呭喌涓嬩綘闇€瑕佹彁渚涗笅杞芥暟鎹殑閾炬帴 +> 鎻愪緵浣犳墍浣跨敤鐨勬暟鎹俊鎭紝妫€鏌ユ暟鎹増鏉冿紝閫氬父鎯呭喌涓嬩綘闇€瑕佹彁渚涗笅杞芥暟鎹殑閾炬帴锛屾暟鎹泦鐨勭洰褰曠粨鏋勶紝鏁版嵁闆嗗ぇ灏忕瓑淇℃伅 + +## 鐗规€э紙鍙€夛級 + +> 灞曠ず浣犲湪妯″瀷瀹炵幇涓娇鐢ㄧ殑鐗规€э紝渚嬪鍒嗗竷寮忚嚜鍔ㄥ苟琛屾垨鑰呮贩鍚堢簿搴︾瓑涓€浜涚壒娈婄殑璁粌鎶€宸� ## 鐜瑕佹眰 @@ -23,7 +27,11 @@ ## 蹇€熷叆闂� -> 浣跨敤涓€鏉′粈涔堟牱鐨勫懡浠ゅ彲浠ョ洿鎺ヨ繍琛� +> 灞曠ず鍙互鐩存帴杩愯鐨勫懡浠� +> 鎸夌収浣犲紑鍙戠殑鐗堟湰锛屽彲鑳藉寘鍚細 +> * 璁粌鍛戒护锛屾帹鐞嗗懡浠わ紝export鍛戒护 +> * Ascend鐗堟湰锛孏PU鐗堟湰锛孋PU鐗堟湰 +> * 绾夸笅杩愯鐗堟湰锛岀嚎涓婅繍琛岀増鏈� ## 鑴氭湰璇存槑 @@ -31,19 +39,19 @@ ### 鑴氭湰鍜屾牱渚嬩唬鐮� -> 鎻忚堪椤圭洰涓瘡涓枃浠剁殑浣滅敤 +> 鎻愪緵瀹屾暣鐨勪唬鐮佺洰褰曞睍绀猴紙鍖呭惈瀛愭枃浠跺す鐨勫睍寮€锛夛紝鎻忚堪姣忎釜鏂囦欢鐨勪綔鐢� ### 鑴氭湰鍙傛暟 -> 娉ㄩ噴妯″瀷涓殑姣忎釜鍙傛暟锛岀壒鍒槸`config.py`涓殑鍙傛暟 +> 娉ㄨВ妯″瀷涓殑姣忎釜鍙傛暟锛岀壒鍒槸`config.py`涓殑鍙傛暟锛屽鏈夊涓厤缃枃浠讹紝璇锋敞瑙f瘡涓€浠介厤缃枃浠剁殑鍙傛暟 ## 璁粌杩囩▼ -> 鎻愪緵璁粌淇℃伅 +> 鎻愪緵璁粌淇℃伅锛屽尯鍒簬quick start锛屾閮ㄥ垎闇€瑕佹彁渚涢櫎鐢ㄦ硶澶栫殑鏃ュ織绛夎缁嗕俊鎭� -### 鐢ㄦ硶 +### 璁粌 -> 鎻愪緵璁粌鑴氭湰鐨勪娇鐢ㄦ儏鍐� +> 鎻愪緵璁粌鑴氭湰鐨勪娇鐢ㄦ柟娉� 渚嬪锛氬湪鏄囪吘涓婁娇鐢ㄥ垎甯冨紡璁粌杩愯涓嬮潰鐨勫懡浠� @@ -51,20 +59,55 @@ bash run_distribute_train.sh [RANK_TABLE_FILE] [PRETRAINED_MODEL] ``` +> 鎻愪緵璁粌杩囩▼鏃ュ織 + +```log +# grep "loss is " train.log +epoch:1 step:390, loss is 1.4842823 +epcoh:2 step:390, loss is 1.0897788 +``` + +> 鎻愪緵璁粌缁撴灉鏃ュ織 +渚嬪锛氳缁僣heckpoint灏嗚淇濆瓨鍦╜XXXX/ckpt_0`涓紝浣犲彲浠ヤ粠濡備笅鐨刲og鏂囦欢涓幏鍙栫粨鏋� + +```log +epoch: 11 step: 7393 ,rpn_loss: 0.02003, rcnn_loss: 0.52051, rpn_cls_loss: 0.01761, rpn_reg_loss: 0.00241, rcnn_cls_loss: 0.16028, rcnn_reg_loss: 0.08411, rcnn_mask_loss: 0.27588, total_loss: 0.54054 +epoch: 12 step: 7393 ,rpn_loss: 0.00547, rcnn_loss: 0.39258, rpn_cls_loss: 0.00285, rpn_reg_loss: 0.00262, rcnn_cls_loss: 0.08002, rcnn_reg_loss: 0.04990, rcnn_mask_loss: 0.26245, total_loss: 0.39804 +``` + ### 杩佺Щ璁粌锛堝彲閫夛級 > 鎻愪緵濡備綍鏍规嵁棰勮缁冩ā鍨嬭繘琛岃縼绉昏缁冪殑鎸囧崡 -### 璁粌缁撴灉 +### 鍒嗗竷寮忚缁� -> 鎻愪緵璁粌缁撴灉 +> 鍚屼笂 -渚嬪锛氳缁僣heckpoint灏嗚淇濆瓨鍦╜XXXX/ckpt_0`涓紝浣犲彲浠ヤ粠濡備笅鐨刲og鏂囦欢涓幏鍙栫粨鏋� +## 璇勪及 +### 璇勪及杩囩▼ + +> 鎻愪緵eval鑴氭湰鐢ㄦ硶 + +### 璇勪及缁撴灉 + +> 鎻愪緵鎺ㄧ悊缁撴灉 + +渚嬪锛氫笂杩皃ython鍛戒护灏嗗湪鍚庡彴杩愯锛屾偍鍙互閫氳繃eval.log鏂囦欢鏌ョ湅缁撴灉銆傛祴璇曟暟鎹泦鐨勫噯纭€у涓嬶細 + +```log +accuracy:{'acc':0.934} ``` -epoch: 11 step: 7393 ,rpn_loss: 0.02003, rcnn_loss: 0.52051, rpn_cls_loss: 0.01761, rpn_reg_loss: 0.00241, rcnn_cls_loss: 0.16028, rcnn_reg_loss: 0.08411, rcnn_mask_loss: 0.27588, total_loss: 0.54054 -epoch: 12 step: 7393 ,rpn_loss: 0.00547, rcnn_loss: 0.39258, rpn_cls_loss: 0.00285, rpn_reg_loss: 0.00262, rcnn_cls_loss: 0.08002, rcnn_reg_loss: 0.04990, rcnn_mask_loss: 0.26245, total_loss: 0.39804 -``` + +## 瀵煎嚭 + +### 瀵煎嚭杩囩▼ + +> 鎻愪緵export鑴氭湰鐢ㄦ硶 + +### 瀵煎嚭缁撴灉 + +> 鎻愪緵export缁撴灉鏃ュ織 ## 鎺ㄧ悊 @@ -72,6 +115,10 @@ epoch: 12 step: 7393 ,rpn_loss: 0.00547, rcnn_loss: 0.39258, rpn_cls_loss: 0.002 > 鎻愪緵鎺ㄧ悊鑴氭湰 +```bash +bash run_infer_310.sh [MINDIR_PATH] [DATASET] [DATA_PATH] [LABEL_FILE] [DEVICE_ID] +``` + ### 鎺ㄧ悊缁撴灉 > 鎻愪緵鎺ㄧ悊缁撴灉 @@ -126,6 +173,7 @@ epoch: 12 step: 7393 ,rpn_loss: 0.00547, rcnn_loss: 0.39258, rpn_cls_loss: 0.002 ## 鍙傝€冩ā鏉� +姝ら儴鍒嗕笉闇€瑕佸嚭鐜板湪浣犵殑README涓� [maskrcnn_readme](https://gitee.com/mindspore/models/blob/master/official/cv/maskrcnn/README_CN.md) ## 璐$尞鎸囧崡 @@ -134,6 +182,8 @@ epoch: 12 step: 7393 ,rpn_loss: 0.00547, rcnn_loss: 0.39258, rpn_cls_loss: 0.002 ### 璐$尞鑰� +姝ら儴鍒嗘牴鎹嚜宸辩殑鎯呭喌杩涜鏇存敼锛屽~鍐欒嚜宸辩殑闄㈡牎鍜岄偖绠� + * [c34](https://gitee.com/c_34) (Huawei) ## ModelZoo 涓婚〉