CodeCamp #33 [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding #9346

ZhikangNiu · 2022-11-18T03:11:32Z

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

超级视客营mmdet基础任务，选择链接中任一 part 代码添加 type hints，为part6的res_layer添加type hints

Modification

为其中的Reslayer和SimplifiedBasicBlock添加了type hint
Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Pre-commit or other linting tools are used to fix the potential lint issues.
The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
The documentation has been modified accordingly, like docstring or example tutorials.

CLAassistant · 2022-11-18T03:11:37Z

All committers have signed the CLA.

mmdet/models/layers/res_layer.py

BIGWangYuDong · 2022-11-18T06:09:06Z

@NoFish-528 Thanks for your PR! You can follow the comments to update your code.

Co-authored-by: BigDong <[email protected]>

ZhikangNiu · 2022-11-18T06:36:17Z

@NoFish-528 Thanks for your PR! You can follow the comments to update your code.

I have updated my code. : ) @BIGWangYuDong

BIGWangYuDong

Line 109 should update

BIGWangYuDong · 2022-12-09T04:15:03Z

mmdet/models/layers/res_layer.py

@@ -114,19 +119,19 @@ class SimplifiedBasicBlock(BaseModule):
    expansion = 1


Line 109: super().init(*layers)

ZhikangNiu · 2022-12-12T11:07:22Z

add type hints for res_layer, se_layer,normed_predictor,positional_encoding

BIGWangYuDong

All Default: change to Defaults to
some typehint are not added
add xx=xx in some necessary place, such as super().xxx(xxx=xxx)

BIGWangYuDong · 2022-12-15T02:36:29Z

mmdet/models/layers/normed_predictor.py

@@ -50,23 +56,23 @@ class NormedConv2d(nn.Conv2d):
        eps (float, optional): The minimal value of divisor to
             keep numerical stability. Default to 1e-6.
        norm_over_kernel (bool, optional): Normalize over kernel.
-             Default to False.
+             Default: False.


Default: -> Defaults to

BIGWangYuDong · 2022-12-15T02:36:50Z

mmdet/models/layers/positional_encoding.py

+                 eps: float = 1e-6,
+                 offset: float = 0.,
+                 init_cfg: OptMultiConfig = None) -> None:
+        super().__init__(init_cfg)


init_cfg=init_cfg

BIGWangYuDong · 2022-12-15T02:37:07Z

mmdet/models/layers/positional_encoding.py

@@ -54,7 +56,7 @@ def __init__(self,
        self.eps = eps
        self.offset = offset

-    def forward(self, mask):
+    def forward(self, mask) -> Tensor:


the type of mask

BIGWangYuDong · 2022-12-15T02:37:20Z

mmdet/models/layers/positional_encoding.py

+        col_num_embed: int = 50,
+        init_cfg: MultiConfig = dict(type='Uniform', layer='Embedding')
+    ) -> None:
+        super().__init__(init_cfg)


init_cfg=init_cfg

BIGWangYuDong · 2022-12-15T02:37:44Z

mmdet/models/layers/se_layer.py

@@ -140,7 +140,7 @@ class ChannelAttention(BaseModule):
    Args:
        channels (int): The input (and output) channels of the attention layer.
        init_cfg (dict or list[dict], optional): Initialization config dict.
-            Defaults to None.
+            Defaults: None


Defaults to None

ZhikangNiu · 2022-12-28T12:22:12Z

All Default: change to Defaults to

some typehint are not added

add xx=xx in some necessary place, such as super().xxx(xxx=xxx)

@BIGWangYuDong Thank you for your suggestion. I update the code with your suggestion

BIGWangYuDong

There are some questions in this PR,

Default to -> Defaults to . It should be Defaults to in docstrings. (Need to check in this PR)
It is suggested to add docstrings in these python files, I give you some example, which may help you,

mmdet/models/layers/positional_encoding.py

mmdet/models/layers/normed_predictor.py

mmdet/models/layers/positional_encoding.py

mmdet/models/layers/res_layer.py

mmdet/models/layers/se_layer.py

BIGWangYuDong

LGTM

…nal_encoding (open-mmlab#9346) * [Fix]:add type hints for res_layer * Update mmdet/models/layers/res_layer.py Co-authored-by: BigDong <[email protected]> * [Fix]:add type hint of norm1 and norm2 * [WIP]:add res_layer type hints * [WIP]:add layer type hints about issue 9234 * [FIX]:add all type hints and change some function note * [FIX]:add docstrings and change default -> defaults Co-authored-by: BigDong <[email protected]>

[Fix]:add type hints for res_layer

4219abe

mm-assistant bot assigned BIGWangYuDong Nov 18, 2022

BIGWangYuDong reviewed Nov 18, 2022

View reviewed changes

mmdet/models/layers/res_layer.py Outdated Show resolved Hide resolved

mmdet/models/layers/res_layer.py Show resolved Hide resolved

ZhikangNiu and others added 2 commits November 18, 2022 14:16

Update mmdet/models/layers/res_layer.py

cff1bd6

Co-authored-by: BigDong <[email protected]>

[Fix]:add type hint of norm1 and norm2

34c3066

ZhikangNiu requested a review from BIGWangYuDong November 19, 2022 08:29

ZwwWayne added this to the 3.0.0rc5 milestone Nov 21, 2022

ZwwWayne requested a review from zytx121 December 5, 2022 08:07

BIGWangYuDong reviewed Dec 9, 2022

View reviewed changes

ZhikangNiu and others added 2 commits December 12, 2022 10:47

[WIP]:add res_layer type hints

54c6a6f

[WIP]:add layer type hints about issue 9234

4dac59f

ZhikangNiu changed the title ~~[Fix]:add type hints for res_layer~~ [WIP]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding Dec 12, 2022

ZwwWayne requested a review from BIGWangYuDong December 12, 2022 06:39

ZhikangNiu changed the title ~~[WIP]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding~~ [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding Dec 14, 2022

BIGWangYuDong reviewed Dec 15, 2022

View reviewed changes

RangiLyu changed the title ~~[Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding~~ CodeCamp #33 [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding Dec 20, 2022

[FIX]:add all type hints and change some function note

beee50d

ZhikangNiu requested review from BIGWangYuDong and removed request for zytx121 December 28, 2022 12:22

BIGWangYuDong reviewed Dec 31, 2022

View reviewed changes

[FIX]:add docstrings and change default -> defaults

bfc849c

BIGWangYuDong approved these changes Jan 3, 2023

View reviewed changes

ZwwWayne merged commit f26153b into open-mmlab:dev-3.x Jan 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CodeCamp #33 [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding #9346

CodeCamp #33 [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding #9346

ZhikangNiu commented Nov 18, 2022

CLAassistant commented Nov 18, 2022 •

edited

Loading

BIGWangYuDong commented Nov 18, 2022

ZhikangNiu commented Nov 18, 2022

BIGWangYuDong left a comment •

edited

Loading

BIGWangYuDong Dec 9, 2022

ZhikangNiu commented Dec 12, 2022

BIGWangYuDong left a comment

BIGWangYuDong Dec 15, 2022

BIGWangYuDong Dec 15, 2022

BIGWangYuDong Dec 15, 2022

BIGWangYuDong Dec 15, 2022

BIGWangYuDong Dec 15, 2022

ZhikangNiu commented Dec 28, 2022

BIGWangYuDong left a comment •

edited

Loading

BIGWangYuDong left a comment

		@@ -114,19 +119,19 @@ class SimplifiedBasicBlock(BaseModule):
		expansion = 1

CodeCamp #33 [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding #9346

CodeCamp #33 [Fix]:add type hints for res_layer, se_layer,normed_predictor,positional_encoding #9346

Conversation

ZhikangNiu commented Nov 18, 2022

Motivation

Modification

BC-breaking (Optional)

Use cases (Optional)

Checklist

CLAassistant commented Nov 18, 2022 • edited Loading

BIGWangYuDong commented Nov 18, 2022

ZhikangNiu commented Nov 18, 2022

BIGWangYuDong left a comment • edited Loading

Choose a reason for hiding this comment

BIGWangYuDong Dec 9, 2022

Choose a reason for hiding this comment

ZhikangNiu commented Dec 12, 2022

BIGWangYuDong left a comment

Choose a reason for hiding this comment

BIGWangYuDong Dec 15, 2022

Choose a reason for hiding this comment

BIGWangYuDong Dec 15, 2022

Choose a reason for hiding this comment

BIGWangYuDong Dec 15, 2022

Choose a reason for hiding this comment

BIGWangYuDong Dec 15, 2022

Choose a reason for hiding this comment

BIGWangYuDong Dec 15, 2022

Choose a reason for hiding this comment

ZhikangNiu commented Dec 28, 2022

BIGWangYuDong left a comment • edited Loading

Choose a reason for hiding this comment

BIGWangYuDong left a comment

Choose a reason for hiding this comment

CLAassistant commented Nov 18, 2022 •

edited

Loading

BIGWangYuDong left a comment •

edited

Loading

BIGWangYuDong left a comment •

edited

Loading