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.

Sign up for GitHub

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

Jump to bottom

[Docs] Normalize config README.md. #7051

Merged
merged 6 commits into from
Jan 27, 2022
Merged

[Docs] Normalize config README.md. #7051

merged 6 commits into from
Jan 27, 2022

Conversation

jbwang1997
Copy link
Collaborator

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

Normalize README.md files in configs.

Modification

Only modify README.md in configs.

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 Jan 20, 2022 •
edited
Loading

Codecov Report

Merging #7051 (9120301) into dev (75f26c8) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #7051      +/-   ##
==========================================
+ Coverage   62.38%   62.40%   +0.01%     
==========================================
  Files         329      330       +1     
  Lines       26176    26200      +24     
  Branches     4432     4436       +4     
==========================================
+ Hits        16331    16349      +18     
- Misses       8975     8979       +4     
- Partials      870      872       +2
Flag Coverage Δ
unittests 62.38% <ø> (+0.01%) ⬆️

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

Impacted Files Coverage Δ
mmdet/models/dense_heads/base_dense_head.py 88.70% <0.00%> (-1.70%) ⬇️
mmdet/datasets/voc.py 30.00% <0.00%> (-0.62%) ⬇️
mmdet/datasets/pipelines/transforms.py 74.27% <0.00%> (-0.18%) ⬇️
mmdet/utils/__init__.py 100.00% <0.00%> (ø)
mmdet/utils/setup_env.py 95.45% <0.00%> (ø)
mmdet/core/bbox/assigners/max_iou_assigner.py 73.68% <0.00%> (+1.31%) ⬆️

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 75f26c8...9120301. Read the comment docs.

ZwwWayne
ZwwWayne reviewed Jan 24, 2022
View reviewed changes
configs/dcn/README.md
@@ -1,4 +1,8 @@
# Deformable Convolutional Networks
# DCN
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should divide the configs in this directory into two directories, one for DCN, one for DCN v2 so that one README only contains configs of one paper.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK. I will check it right away.

ZwwWayne
ZwwWayne reviewed Jan 24, 2022
View reviewed changes
Copy link
Collaborator

@ZwwWayne ZwwWayne left a comment

Choose a reason for hiding this comment

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

Looks good to me after resolving comments. Involve @zhouzaida to take a look

zhouzaida
zhouzaida reviewed Jan 25, 2022
View reviewed changes
configs/albu_example/README.md Outdated
@@ -1,5 +1,9 @@
# Albu Example

> [Albumentations: fast and flexible image augmentations](https://arxiv.org/abs/1809.06839)

<!-- [OTHER] -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<!-- [OTHER] -->
<!-- [OTHERS] -->

@ZwwWayne ZwwWayne mentioned this pull request Jan 25, 2022
Merged
9 tasks
@jbwang1997 jbwang1997 added the WIP Working in progress label Jan 25, 2022
@jbwang1997 jbwang1997 removed the WIP Working in progress label Jan 25, 2022
zhouzaida
zhouzaida reviewed Jan 26, 2022
View reviewed changes
.pre-commit-config.yaml Outdated Show resolved Hide resolved
@jbwang1997 @zhouzaida
Change pre-commit-hooks
649af62 
Change pre-commit-hooks to open-mmlab

Co-authored-by: Zaida Zhou <[email protected]>
zhouzaida
zhouzaida reviewed Jan 26, 2022
View reviewed changes
configs/fast_rcnn/README.md Outdated
<div align=center>
<img src="https://user-images.githubusercontent.com/40661020/143882189-6258c05c-f2a1-4320-9282-7e2f2d502eb2.png"/>
</div>

<!-- [PAPER_TITLE: Fast R-CNN] -->
<!-- [PAPER_URL: https://arxiv.org/abs/1504.08083] -->
## Results and models
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why did it miss content?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The section Results and Models in original configs/fast_rcnn/README.md is empty. So I keep this setting.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to confirm why it is empty. If it is indeed empty, the section should be removed.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We do not release the model of Fast RCNN since v2.0. Therefore, we do not have checkpoints for them. I

@zhouzaida
Copy link
Collaborator

In addition, we also need to confirm whether stat.py works as expected because we refactor the content of readme.

@jbwang1997
Copy link
Collaborator Author

In addition, we also need to confirm whether stat.py works as expected because we refactor the content of readme.

I checked the stat.py. It can generate modelzoo_statistics.md successfully.

@ZwwWayne ZwwWayne merged commit 4bdb312 into open-mmlab:dev Jan 27, 2022
@jbwang1997 jbwang1997 mentioned this pull request Feb 2, 2022
Merged
chhluo pushed a commit to chhluo/mmdetection that referenced this pull request Feb 21, 2022
@jbwang1997 @zhouzaida @chhluo
[Docs] Normalize config README.md. (open-mmlab#7051)
05da54f 
* regularize README.md

* Check README.md. Check backbone metafile

* Check backbone metafile

* Add metafile for some algorithm

* Change pre-commit-hooks

Change pre-commit-hooks to open-mmlab

Co-authored-by: Zaida Zhou <[email protected]>

* Add new metafile in model-index.yml

Co-authored-by: Zaida Zhou <[email protected]>
ZwwWayne pushed a commit that referenced this pull request Jul 18, 2022
@jbwang1997 @zhouzaida
[Docs] Normalize config README.md. (#7051)
de5138c 
* regularize README.md

* Check README.md. Check backbone metafile

* Check backbone metafile

* Add metafile for some algorithm

* Change pre-commit-hooks

Change pre-commit-hooks to open-mmlab

Co-authored-by: Zaida Zhou <[email protected]>

* Add new metafile in model-index.yml

Co-authored-by: Zaida Zhou <[email protected]>
ZwwWayne pushed a commit to ZwwWayne/mmdetection that referenced this pull request Jul 19, 2022
@jbwang1997 @zhouzaida @ZwwWayne
[Docs] Normalize config README.md. (open-mmlab#7051)
68ac148 
* regularize README.md

* Check README.md. Check backbone metafile

* Check backbone metafile

* Add metafile for some algorithm

* Change pre-commit-hooks

Change pre-commit-hooks to open-mmlab

Co-authored-by: Zaida Zhou <[email protected]>

* Add new metafile in model-index.yml

Co-authored-by: Zaida Zhou <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zhouzaida zhouzaida zhouzaida left review comments

@ZwwWayne ZwwWayne ZwwWayne approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jbwang1997 @zhouzaida @ZwwWayne