[Refactor] Use pycocotools instead of mmpycocotools by xvjiarui · Pull Request #4939 · open-mmlab/mmdetection

xvjiarui · 2021-04-12T02:35:20Z

Motivation:

mmpycocotools and official pycocotool have the same package name. Users install pycocotools first fail to run MMDetection.
As the pycocotool is maintained by the official team now, we decide to deprecate the mmpycocotool. To make official pycocotools works with MMDetection, we add some function aliases for pycocotools.coco.COCO.

Besides, this PR makes users able to install MMDetection and Detectron2 under the same environment.

Fixed #4565

mmdet/datasets/api_wrappers/coco_api.py

codecov · 2021-04-12T03:53:00Z

Codecov Report

Merging #4939 (6467d7d) into master (5ebba9a) will decrease coverage by 0.17%.
The diff coverage is 53.77%.

❗ Current head 6467d7d differs from pull request most recent head bc0b69a. Consider uploading reports for the commit bc0b69a to get more accurate results

@@            Coverage Diff             @@
##           master    #4939      +/-   ##
==========================================
- Coverage   65.63%   65.46%   -0.18%     
==========================================
  Files         255      257       +2     
  Lines       19984    20053      +69     
  Branches     3394     3406      +12     
==========================================
+ Hits        13117    13127      +10     
- Misses       6165     6219      +54     
- Partials      702      707       +5

Flag	Coverage Δ
unittests	`65.45% <53.77%> (-0.15%)`	⬇️

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

Impacted Files	Coverage Δ
mmdet/core/bbox/assigners/region_assigner.py	`12.87% <0.00%> (-0.82%)`	⬇️
mmdet/models/dense_heads/vfnet_head.py	`31.48% <0.00%> (ø)`
mmdet/datasets/lvis.py	`15.17% <12.50%> (+1.17%)`	⬆️
...mdet/core/bbox/iou_calculators/iou2d_calculator.py	`82.50% <40.90%> (-14.28%)`	⬇️
mmdet/datasets/custom.py	`63.47% <65.38%> (+0.35%)`	⬆️
mmdet/datasets/api_wrappers/coco_api.py	`87.50% <87.50%> (ø)`
mmdet/datasets/api_wrappers/__init__.py	`100.00% <100.00%> (ø)`
mmdet/datasets/coco.py	`46.25% <100.00%> (-0.06%)`	⬇️
mmdet/models/dense_heads/fcos_head.py	`56.69% <100.00%> (+0.39%)`	⬆️
mmdet/models/roi_heads/mask_scoring_roi_head.py	`55.35% <0.00%> (-32.15%)`	⬇️
... and 7 more

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 5ebba9a...bc0b69a. Read the comment docs.

requirements/optional.txt

ZwwWayne · 2021-04-14T02:29:40Z

The refactoring LGTM. We should also tell users to switch to pycocotools if they already install mmpycocotools.

xvjiarui · 2021-04-14T03:50:49Z

PR message updated.

ZwwWayne · 2021-04-14T05:14:30Z

docs/compatibility.md

+## pycocotools compatibility
+
+Before [PR 4939](https://github.com/open-mmlab/mmdetection/pull/4939), since `pycocotools` and `mmpycocotool` have the same package name, if users already installed `pyccocotools` (installed Detectron2 first under the same environment), then the setup of MMDetection will skip installing `mmpycocotool`. Thux MMDetection fails due to the missing `mmpycocotools`.
+[PR 4939](https://github.com/open-mmlab/mmdetection/pull/4939) deprecates mmpycocotools in favor official pycocotools.


in favor of

ZwwWayne · 2021-04-14T05:15:29Z

docs/compatibility.md

+
+## pycocotools compatibility
+
+Before [PR 4939](https://github.com/open-mmlab/mmdetection/pull/4939), since `pycocotools` and `mmpycocotool` have the same package name, if users already installed `pyccocotools` (installed Detectron2 first under the same environment), then the setup of MMDetection will skip installing `mmpycocotool`. Thux MMDetection fails due to the missing `mmpycocotools`.


Indicate that mmpycocotools works for both MMDet and Detectron2, so it will be fine if MMDetection is installed before Detectron2.

docs/compatibility.md

ppwwyyxx · 2021-04-14T05:50:13Z

mmdet/datasets/lvis.py

        try:
            import lvis
-            assert lvis.__version__ >= '10.5.3'
+            if lvis.__version__ >= '10.5.3':


This will trigger an AttributeError for official LVIS

Thx! Fixed in #4958

ppwwyyxx · 2021-04-14T05:51:25Z

mmdet/datasets/api_wrappers/coco_api.py

+        if not getattr(pycocotools, '__version__', '0') >= '12.0.2':
+            warnings.warn(
+                'mmpycocotools is deprecated. Please install official pycocotools by "pip install pycocotools"',  # noqa: E501
+                UserWarning)


this will print a warning for official pycocotools

Thx! Fixed in #4958

fcakyon · 2021-04-15T10:12:34Z

@xvjiarui @ppwwyyxx @ZwwWayne The official pycocotools does not provide windows support because of this line in setup.py, how to use mmdetection on windows after this pr?

lucasjinreal · 2021-12-20T06:22:46Z

@fcakyon

ERROR: Could not find a version that satisfies the requirement pycocotools-windows (from mmdet) (from versions: none)
ERROR: No matching distribution found for pycocotools-windows```

fcakyon · 2021-12-20T08:42:20Z

@jinfagang i have opened a pr explaining the situation: #6838

xvjiarui added 2 commits April 11, 2021 19:34

[Refactor] Use pycocotools instead of mmpycocotools

225db29

add missing

c723c76

ZwwWayne reviewed Apr 12, 2021

View reviewed changes

mmdet/datasets/api_wrappers/coco_api.py Show resolved Hide resolved

add more docstring

038190b

ZwwWayne reviewed Apr 13, 2021

View reviewed changes

requirements/optional.txt Show resolved Hide resolved

ZwwWayne approved these changes Apr 14, 2021

View reviewed changes

add compat docs

b8cc53a

xvjiarui requested a review from ZwwWayne April 14, 2021 03:50

ZwwWayne reviewed Apr 14, 2021

View reviewed changes

docs/compatibility.md Outdated Show resolved Hide resolved

update doc

bc0b69a

ZwwWayne approved these changes Apr 14, 2021

View reviewed changes

ZwwWayne merged commit 5795367 into open-mmlab:master Apr 14, 2021

ppwwyyxx reviewed Apr 14, 2021

View reviewed changes

xvjiarui mentioned this pull request Apr 14, 2021

[Bug Fix] Fix pycocotools warning #4958

Merged

fcakyon mentioned this pull request Apr 15, 2021

new mmdet dependency does not support windows #4970

Closed

stacezhou mentioned this pull request Jul 21, 2021

[Fix] fix cocoapi in parser open-mmlab/mmtracking#218

Closed

ZwwWayne mentioned this pull request Sep 3, 2021

MMPycocotools is no longer necessary open-mmlab/mmtracking#259

Closed

fcakyon mentioned this pull request Dec 20, 2021

switch back to original pycocotools #6838

Merged


		## pycocotools compatibility

		Before [PR 4939](https://github.com/open-mmlab/mmdetection/pull/4939), since `pycocotools` and `mmpycocotool` have the same package name, if users already installed `pyccocotools` (installed Detectron2 first under the same environment), then the setup of MMDetection will skip installing `mmpycocotool`. Thux MMDetection fails due to the missing `mmpycocotools`.

Conversation

xvjiarui commented Apr 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation:

Uh oh!

Uh oh!

codecov bot commented Apr 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

ZwwWayne commented Apr 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xvjiarui commented Apr 14, 2021

Uh oh!

ZwwWayne Apr 14, 2021

Choose a reason for hiding this comment

Uh oh!

ZwwWayne Apr 14, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ppwwyyxx Apr 14, 2021

Choose a reason for hiding this comment

Uh oh!

xvjiarui Apr 14, 2021

Choose a reason for hiding this comment

Uh oh!

ppwwyyxx Apr 14, 2021

Choose a reason for hiding this comment

Uh oh!

xvjiarui Apr 14, 2021

Choose a reason for hiding this comment

Uh oh!

fcakyon commented Apr 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lucasjinreal commented Dec 20, 2021

Uh oh!

fcakyon commented Dec 20, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

xvjiarui commented Apr 12, 2021 •

edited

Loading

codecov bot commented Apr 12, 2021 •

edited

Loading

ZwwWayne commented Apr 14, 2021 •

edited

Loading

fcakyon commented Apr 15, 2021 •

edited

Loading