[Docs] Normalize config README.md. by jbwang1997 · Pull Request #7051 · open-mmlab/mmdetection

jbwang1997 · 2022-01-20T15:50:28Z

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

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.

codecov · 2022-01-20T16:08:15Z

Codecov Report

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

@@            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 · 2022-01-24T15:51:44Z

configs/dcn/README.md

@@ -1,4 +1,8 @@
-# Deformable Convolutional Networks
+# DCN


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.

OK. I will check it right away.

ZwwWayne

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

zhouzaida · 2022-01-25T01:49:21Z

configs/albu_example/README.md


+> [Albumentations: fast and flexible image augmentations](https://arxiv.org/abs/1809.06839)
+
+<!-- [OTHER] -->


Suggested change

.pre-commit-config.yaml

Change pre-commit-hooks to open-mmlab Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

zhouzaida · 2022-01-26T01:59:03Z

configs/fast_rcnn/README.md


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


Why did it miss content?

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

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

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

zhouzaida · 2022-01-26T03:13:55Z

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

jbwang1997 · 2022-01-26T04:41:34Z

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.

* 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 <58739961+zhouzaida@users.noreply.github.com> * Add new metafile in model-index.yml Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

regularize README.md

5edb10f

ZwwWayne reviewed Jan 24, 2022

View reviewed changes

zhouzaida reviewed Jan 25, 2022

View reviewed changes

ZwwWayne mentioned this pull request Jan 25, 2022

[Feature] Support DyHead #6823

Merged

9 tasks

Check README.md. Check backbone metafile

63d2564

jbwang1997 added the WIP Working in progress label Jan 25, 2022

jbwang1997 added 2 commits January 25, 2022 23:50

Check backbone metafile

447a18f

Add metafile for some algorithm

4f14444

jbwang1997 removed the WIP Working in progress label Jan 25, 2022

jbwang1997 requested a review from ZwwWayne January 25, 2022 17:03

zhouzaida reviewed Jan 26, 2022

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

Change pre-commit-hooks

649af62

Change pre-commit-hooks to open-mmlab Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

zhouzaida reviewed Jan 26, 2022

View reviewed changes

Add new metafile in model-index.yml

9120301

ZwwWayne approved these changes Jan 27, 2022

View reviewed changes

ZwwWayne merged commit 4bdb312 into open-mmlab:dev Jan 27, 2022

jbwang1997 mentioned this pull request Feb 2, 2022

[Fix] cannot to save the best checkpoint when the key_score is None #7101

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Normalize config README.md.#7051

[Docs] Normalize config README.md.#7051
ZwwWayne merged 6 commits intoopen-mmlab:devfrom
jbwang1997:config_docs

jbwang1997 commented Jan 20, 2022

Uh oh!

codecov bot commented Jan 20, 2022 •

edited

Loading

Uh oh!

ZwwWayne Jan 24, 2022

Uh oh!

jbwang1997 Jan 25, 2022

Uh oh!

ZwwWayne left a comment

Uh oh!

zhouzaida Jan 25, 2022

Uh oh!

Uh oh!

zhouzaida Jan 26, 2022

Uh oh!

jbwang1997 Jan 26, 2022

Uh oh!

zhouzaida Jan 26, 2022

Uh oh!

ZwwWayne Jan 26, 2022

Uh oh!

zhouzaida commented Jan 26, 2022

Uh oh!

jbwang1997 commented Jan 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


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

		<!-- [OTHER] -->

Conversation

jbwang1997 commented Jan 20, 2022

Motivation

Modification

BC-breaking (Optional)

Use cases (Optional)

Checklist

Uh oh!

codecov bot commented Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ZwwWayne Jan 24, 2022

Choose a reason for hiding this comment

Uh oh!

jbwang1997 Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

ZwwWayne left a comment

Choose a reason for hiding this comment

Uh oh!

zhouzaida Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zhouzaida Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

jbwang1997 Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

zhouzaida Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

ZwwWayne Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

zhouzaida commented Jan 26, 2022

Uh oh!

jbwang1997 commented Jan 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jan 20, 2022 •

edited

Loading