Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] userful hooks #7810

Merged
merged 12 commits into from
May 13, 2022
Merged

[Docs] userful hooks #7810

merged 12 commits into from
May 13, 2022

Conversation

chhluo
Copy link
Collaborator

@chhluo chhluo commented Apr 24, 2022

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

Add a tutorial to introduce useful hooks provided by MMDetection and MMCV.

Modification

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

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

@codecov
Copy link

codecov bot commented Apr 24, 2022

Codecov Report

Merging #7810 (cc1a487) into dev (6dbca90) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev    #7810      +/-   ##
==========================================
- Coverage   64.87%   64.87%   -0.01%     
==========================================
  Files         352      352              
  Lines       28504    28504              
  Branches     4822     4822              
==========================================
- Hits        18493    18491       -2     
+ Misses       9030     9029       -1     
- Partials      981      984       +3     
Flag Coverage Δ
unittests 64.85% <ø> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
mmdet/core/hook/memory_profiler_hook.py 95.65% <ø> (ø)
mmdet/core/bbox/samplers/random_sampler.py 75.00% <0.00%> (-5.56%) ⬇️
mmdet/utils/setup_env.py 88.00% <0.00%> (-4.00%) ⬇️
mmdet/models/roi_heads/mask_heads/maskiou_head.py 87.35% <0.00%> (-2.30%) ⬇️
mmdet/datasets/builder.py 52.08% <0.00%> (-1.05%) ⬇️
mmdet/core/bbox/assigners/sim_ota_assigner.py 83.63% <0.00%> (+3.63%) ⬆️

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 6dbca90...cc1a487. Read the comment docs.

Copy link
Collaborator

@jbwang1997 jbwang1997 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ZwwWayne ZwwWayne merged commit 48226ea into open-mmlab:dev May 13, 2022
@chhluo chhluo deleted the docs_for_hook branch May 13, 2022 12:31
ZwwWayne pushed a commit that referenced this pull request Jul 18, 2022
* update docstring

* update

* add useful_hook

* update

* update

* add a space

* update

* fix link

* update

* update

* update

* fix lint
ZwwWayne pushed a commit to ZwwWayne/mmdetection that referenced this pull request Jul 19, 2022
* update docstring

* update

* add useful_hook

* update

* update

* add a space

* update

* fix link

* update

* update

* update

* fix lint
ZwwWayne pushed a commit to ZwwWayne/mmdetection that referenced this pull request Jul 19, 2022
* update docstring

* update

* add useful_hook

* update

* update

* add a space

* update

* fix link

* update

* update

* update

* fix lint
SakiRinn pushed a commit to SakiRinn/mmdetection-locount that referenced this pull request Mar 17, 2023
* update docstring

* update

* add useful_hook

* update

* update

* add a space

* update

* fix link

* update

* update

* update

* fix lint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants