Easy contributions! Add typehint and translate docs for MMDetection~

[hhaAndroid]

Hi guys, we are planning to add typehint and docstring for python code and translate docs from English to Chinese in MMDetection. PRs from the community are welcomed. To make the community fully aware of the progress, we list the progress here. Please feel free to leave a message and create a PR if you are willing to do these.

• part-1 Owner @simpleiswell
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/datasets/api_wrappers/coco_api.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/datasets/utils.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/engine/hooks/set_epoch_info_hook.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/engine/hooks/sync_norm_hook.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/engine/hooks/utils.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/engine/optimizers/layer_decay_optimizer_constructor.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/evaluation/functional/bbox_overlaps.py
• part-2 Owner @cyhrane
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/evaluation/functional/mean_ap.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/evaluation/functional/panoptic_utils.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/evaluation/functional/recall.py
• part-3 Owner @hjy94wo777
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/csp_darknet.py Modify some typehints in csp_darknet.py #9402
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/darknet.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/detectors_resnet.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/detectors_resnext.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/efficientnet.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/hrnet.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/mobilenet_v2.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/pvt.py
• part-4 Owner @pgh79
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/regnet.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/res2net.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/resnest.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/resnet.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/resnext.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/ssd_vgg.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/swin.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/backbones/trident_resnet.py
• part-5
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/brick_wrappers.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/conv_upsample.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/csp_layer.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/dropblock.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/inverted_residual.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/matrix_nms.py
• part-6 Owner @NoFish-528 CodeCamp #33 [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding #9346
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/normed_predictor.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/positional_encoding.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/res_layer.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/layers/se_layer.py
• part-7 Owner @SmallingCar
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/accuracy.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/ae_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/balanced_l1_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/cross_entropy_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/dice_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/focal_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/gfocal_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/ghm_loss.py
• part-8 Owner @lihua199710 [Fix] add type hints of part 8 including iou_loss.py, etc. #9397
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/iou_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/kd_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/mse_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/seesaw_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/smooth_l1_loss.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/utils.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/losses/varifocal_loss.py
• part-9 Owner @JunyaoHu
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/bfp.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/channel_mapper.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/dilated_encoder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/dyhead.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/fpg.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/fpn_carafe.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/hrfpn.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/nasfcos_fpn.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/pafpn.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/rfp.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/ssd_neck.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/yolo_neck.py [fix] add type hints for yolo_neck #9383
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/necks/yolox_pafpn.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/roi_heads/shared_heads/res_layer.py
• part-10
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/coders/bucketing_bbox_coder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/coders/delta_xywh_bbox_coder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/coders/distance_point_bbox_coder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/coders/legacy_delta_xywh_bbox_coder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/coders/pseudo_bbox_coder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/coders/tblr_bbox_coder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/coders/yolo_bbox_coder.py
• part-11 Owner @QJC123654 CodeCamp #33 #9468
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/prior_generators/anchor_generator.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/prior_generators/point_generator.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/prior_generators/utils.py
• part-12
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/samplers/combined_sampler.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/samplers/instance_balanced_pos_sampler.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/samplers/iou_balanced_neg_sampler.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/samplers/ohem_sampler.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/samplers/sampling_result.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/task_modules/builder.py
• part-13 Owner @naixie
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/utils/gaussian_target.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/utils/make_divisible.py
• part-14
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/utils/misc.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/models/builder.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/compat_config.py
• part-15 @fuyueagain
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/structures/bbox/bbox_overlaps.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/structures/mask/mask_target.py
• part-16
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/structures/mask/structures.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/structures/mask/utils.py
• part-17
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/contextmanagers.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/dist_utils.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/logger.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/memory.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/misc.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/profiling.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/utils/split_batch.py
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/mmdet/version.py

Docs translation or update

• part-1 Owner @137208 CodeCamp #34 [Docs] Add Chinese version of single_stage_as_rpn.md and test_results_submission.md #9434
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/single_stage_as_rpn.md
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/test_results_submission.md
• part-2 Owner @tianleiSHI CodeCamp #34 [Doc] update the zh_cn user_guides of useful_tools.md and useful_hooks.md #9453
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/useful_tools.md
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/useful_hooks.md
• part-3 Owner @Laymanpython
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/test.md
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/train.md
• part-4 Owner @DanShouzhu [Doc]: update user guide: "finetune.md, inference.md" #9578
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/finetune.md
  • https://github.com/open-mmlab/mmdetection/blob/dev-3.x/docs/zh_cn/user_guides/inference.md

[ZhikangNiu]

牛志康 type hints part6

[hjy94wo777]

胡健谕 type hints part-3

[naixie]

林钰睿 type hints part-13

[pgh79]

彭国宏 type hints part-4

[QJC123654]

祁军成 type hints part-11

[JunyaoHu]

胡钧耀 type hints part-9

[SmallingCar]

车艳波 type hints part-7

[Laymanpython]

李鑫 Docs translation or update part-3

[ZXH-NEU]

张新慧 type hints part1

[lihua199710]

liteng type hints part-8

[SmallingCar]

I will try it. Tank you very much. 在 2022-11-22 20:46:16，Laymanpython ***@***.***> 写道： 李鑫 Docs translation or update part-3 — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.Message ID: ***@***.***>

[Laymanpython]

李鑫 Docs translation or update part-3

…

---Original--- From: ***@***.***> Date: Sun, Nov 27, 2022 04:23 AM To: ***@***.***>; Cc: ***@***.******@***.***>; Subject: Re: [open-mmlab/mmdetection] Easy contributions! Add typehint and translate docs for MMDetection~ (Discussion #9234) I will try it. Tank you very much. 在 2022-11-22 20:46:16，Laymanpython ***@***.***> 写道： 李鑫 Docs translation or update part-3 — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.Message ID: ***@***.***> — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

[tianleiSHI]

石田蕾 Docs translation or update part-2

[cyhrane]

邱奕涵 type hints part2

[137208]

刘浩 Docs translation or update part1

[fuyueagain]

wang yingying type hints part15

[DanShouzhu]

淡寿祝 Docs translation or update part 4

[IRONICBo]

Asklv type hints part-10

[IRONICBo]

#10040