[Docs] Add Chinese version of conventions #5825

wangbo-zhao · 2021-08-08T09:29:15Z

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

This PR is for chinese version of conventions.md

codecov · 2021-08-09T02:25:20Z

Codecov Report

Merging #5825 (fa8b8b9) into master (1077152) will decrease coverage by 4.92%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5825      +/-   ##
==========================================
- Coverage   66.46%   61.54%   -4.93%     
==========================================
  Files         281      305      +24     
  Lines       22019    23896    +1877     
  Branches     3659     3951     +292     
==========================================
+ Hits        14635    14706      +71     
- Misses       6632     8405    +1773     
- Partials      752      785      +33

Flag	Coverage Δ
unittests	`61.51% <ø> (-4.93%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
mmdet/models/roi_heads/mask_heads/grid_head.py	`7.69% <0.00%> (-87.70%)`	⬇️
mmdet/models/roi_heads/mask_scoring_roi_head.py	`16.98% <0.00%> (-75.48%)`	⬇️
mmdet/models/dense_heads/nasfcos_head.py	`28.12% <0.00%> (-68.75%)`	⬇️
mmdet/models/roi_heads/grid_roi_head.py	`13.04% <0.00%> (-57.61%)`	⬇️
mmdet/models/necks/nas_fpn.py	`14.28% <0.00%> (-55.56%)`	⬇️
mmdet/models/utils/normed_predictor.py	`33.33% <0.00%> (-50.01%)`	⬇️
...et/models/roi_heads/bbox_heads/double_bbox_head.py	`22.72% <0.00%> (-48.49%)`	⬇️
mmdet/models/necks/nasfcos_fpn.py	`15.49% <0.00%> (-47.89%)`	⬇️
...et/models/roi_heads/mask_heads/coarse_mask_head.py	`23.80% <0.00%> (-47.62%)`	⬇️
mmdet/models/necks/fpg.py	`11.41% <0.00%> (-46.74%)`	⬇️
... and 294 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1077152...fa8b8b9. Read the comment docs.

docs_zh-CN/conventions.md

AronLin · 2021-08-09T04:50:36Z

docs_zh-CN/conventions.md

+## 损失
+在MMDetection中，`dict` 包含着所有的损失和评价指标，他们将会由`model(**data)`返回。
+
+例如，在bbox head中，


In our standards, there should be a space between English (including numbers) and Chinese.
So it should be 在 bbox head 中.

docs_zh-CN/conventions.md

AronLin · 2021-08-09T04:53:47Z

docs_zh-CN/conventions.md

+
+'bbox_head.loss()'在模型正向阶段会被调用。返回的字典中包含了`'loss_bbox'`, `'loss_cls'`, `'acc'`。只有`'loss_bbox'`, `'loss_cls'`会被用于反向传播，`'acc'`只会被作为评价指标来监控训练过程。
+
+我们默认，只有那些键的名称中包含'loss'的值会被用于反向传播。这个行为可以通过修改`BaseDetector.train_step()`来改变。


Space between English and Chinese.

docs_zh-CN/conventions.md

AronLin · 2021-08-09T04:57:44Z

Please re-request review if you fix my comments.

AronLin

Please add space between English(including numbers) and Chinese. This is a unified standard in MMDetection.

AronLin · 2021-08-12T12:36:32Z

docs_zh-CN/conventions.md

+## 损失
+在MMDetection中，`dict` 包含着所有的损失和评价指标，他们将会由`model(**data)`返回。
+
+例如，在bbox head中，


In our standards, there should be a space between English (including numbers) and Chinese.
So it should be 在 bbox head 中.

docs_zh-CN/conventions.md

AronLin · 2021-08-12T12:42:27Z

docs_zh-CN/conventions.md

+
+'bbox_head.loss()'在模型正向阶段会被调用。返回的字典中包含了`'loss_bbox'`, `'loss_cls'`, `'acc'`。只有`'loss_bbox'`, `'loss_cls'`会被用于反向传播，`'acc'`只会被作为评价指标来监控训练过程。
+
+我们默认，只有那些键的名称中包含'loss'的值会被用于反向传播。这个行为可以通过修改`BaseDetector.train_step()`来改变。


Space between English and Chinese.

docs_zh-CN/conventions.md

AronLin · 2021-09-01T03:59:13Z

Kindly ping @BIGWangYuDong for the final check.

docs_zh-CN/conventions.md

BIGWangYuDong · 2021-09-01T04:05:56Z

LGTM, two details need to be modified

Update conventions.md

e21b5ee

wangbo-zhao changed the title ~~Update conventions.md~~ [doc] chinese version of conventions.md Aug 8, 2021

ZwwWayne requested a review from AronLin August 9, 2021 01:51

BIGWangYuDong mentioned this pull request Aug 9, 2021

Progress of Chinese Documentation #5529

Closed

21 tasks

BIGWangYuDong changed the title ~~[doc] chinese version of conventions.md~~ [Docs] Add Chinese version of conventions Aug 9, 2021

AronLin reviewed Aug 9, 2021

View reviewed changes

wangbo-zhao added 3 commits August 10, 2021 15:08

Update conventions.md

6011b18

Update conventions.md

5c83efd

Update conventions.md

6d290b2

wangbo-zhao requested a review from AronLin August 10, 2021 07:31

AronLin reviewed Aug 12, 2021

View reviewed changes

wangbo-zhao added 4 commits August 13, 2021 15:36

Update conventions.md

5661640

Update conventions.md

10125db

Update conventions.md

d2758ae

Update conventions.md

99d21ba

wangbo-zhao requested a review from AronLin August 13, 2021 07:37

Update conventions.md

97980ee

AronLin approved these changes Aug 16, 2021

View reviewed changes

AronLin requested a review from BIGWangYuDong September 1, 2021 03:59

BIGWangYuDong reviewed Sep 1, 2021

View reviewed changes

docs_zh-CN/conventions.md Outdated Show resolved Hide resolved

docs_zh-CN/conventions.md Outdated Show resolved Hide resolved

Update according to comments.

fa8b8b9

ZwwWayne merged commit fa10539 into open-mmlab:master Sep 17, 2021

ZwwWayne pushed a commit to ZwwWayne/mmdetection that referenced this pull request Jul 19, 2022

[Docs] Add Chinese version of conventions (open-mmlab#5825)

acca6f0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Add Chinese version of conventions #5825

[Docs] Add Chinese version of conventions #5825

wangbo-zhao commented Aug 8, 2021

codecov bot commented Aug 9, 2021 •

edited

Loading

AronLin Aug 9, 2021

AronLin Aug 12, 2021

AronLin Aug 9, 2021

AronLin Aug 12, 2021

AronLin commented Aug 9, 2021

AronLin left a comment

AronLin Aug 12, 2021

AronLin Aug 12, 2021

AronLin commented Sep 1, 2021

BIGWangYuDong commented Sep 1, 2021


		'bbox_head.loss()'在模型正向阶段会被调用。返回的字典中包含了`'loss_bbox'`, `'loss_cls'`, `'acc'`。只有`'loss_bbox'`, `'loss_cls'`会被用于反向传播，`'acc'`只会被作为评价指标来监控训练过程。

		我们默认，只有那些键的名称中包含'loss'的值会被用于反向传播。这个行为可以通过修改`BaseDetector.train_step()`来改变。

[Docs] Add Chinese version of conventions #5825

[Docs] Add Chinese version of conventions #5825

Conversation

wangbo-zhao commented Aug 8, 2021

Motivation

codecov bot commented Aug 9, 2021 • edited Loading

Codecov Report

AronLin Aug 9, 2021

Choose a reason for hiding this comment

AronLin Aug 12, 2021

Choose a reason for hiding this comment

AronLin Aug 9, 2021

Choose a reason for hiding this comment

AronLin Aug 12, 2021

Choose a reason for hiding this comment

AronLin commented Aug 9, 2021

AronLin left a comment

Choose a reason for hiding this comment

AronLin Aug 12, 2021

Choose a reason for hiding this comment

AronLin Aug 12, 2021

Choose a reason for hiding this comment

AronLin commented Sep 1, 2021

BIGWangYuDong commented Sep 1, 2021

codecov bot commented Aug 9, 2021 •

edited

Loading