[Improvement] Decouple dependency (#254)

* add dependency placeholder * update requirements * decouple mmcls dependencies Co-authored-by: huangpengsheng <huangpengsheng@sensetime.com>
open-mmlab · Aug 30, 2022 · f45e2bd · f45e2bd
1 parent e3390ce
commit f45e2bd
Show file tree

Hide file tree

Showing 15 changed files with 76 additions and 19 deletions.
diff --git a/mmrazor/models/architectures/backbones/searchable_mobilenet.py b/mmrazor/models/architectures/backbones/searchable_mobilenet.py
@@ -2,15 +2,21 @@
 import copy
 from typing import Dict, List, Optional, Sequence, Tuple, Union
 
-from mmcls.models.backbones.base_backbone import BaseBackbone
-from mmcls.models.utils import make_divisible
 from mmcv.cnn import ConvModule
 from mmengine.model import Sequential
 from torch import Tensor
 from torch.nn.modules.batchnorm import _BatchNorm
 
 from mmrazor.registry import MODELS
 
+try:
+    from mmcls.models.backbones.base_backbone import BaseBackbone
+    from mmcls.models.utils import make_divisible
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    BaseBackbone = get_placeholder('mmcls')
+    make_divisible = get_placeholder('mmcls')
+
 
 @MODELS.register_module()
 class SearchableMobileNet(BaseBackbone):

diff --git a/mmrazor/models/architectures/backbones/searchable_shufflenet_v2.py b/mmrazor/models/architectures/backbones/searchable_shufflenet_v2.py
@@ -3,7 +3,6 @@
 from typing import Dict, List, Optional, Sequence, Tuple, Union
 
 import torch.nn as nn
-from mmcls.models.backbones.base_backbone import BaseBackbone
 from mmcv.cnn import ConvModule
 from mmengine.model import ModuleList, Sequential
 from mmengine.model.weight_init import constant_init, normal_init
@@ -12,6 +11,12 @@
 
 from mmrazor.registry import MODELS
 
+try:
+    from mmcls.models.backbones.base_backbone import BaseBackbone
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    BaseBackbone = get_placeholder('mmcls')
+
 
 @MODELS.register_module()
 class SearchableShuffleNetV2(BaseBackbone):

diff --git a/mmrazor/models/architectures/heads/darts_subnet_head.py b/mmrazor/models/architectures/heads/darts_subnet_head.py
@@ -2,14 +2,21 @@
 from typing import List, Tuple
 
 import torch
-from mmcls.evaluation import Accuracy
-from mmcls.models.heads import LinearClsHead
-from mmcls.structures import ClsDataSample
 from torch import nn
 
 from mmrazor.models.utils import add_prefix
 from mmrazor.registry import MODELS
 
+try:
+    from mmcls.evaluation import Accuracy
+    from mmcls.models.heads import LinearClsHead
+    from mmcls.structures import ClsDataSample
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    Accuracy = get_placeholder('mmcls')
+    LinearClsHead = get_placeholder('mmcls')
+    ClsDataSample = get_placeholder('mmcls')
+
 
 @MODELS.register_module()
 class DartsSubnetClsHead(LinearClsHead):

diff --git a/mmrazor/models/losses/kd_soft_ce_loss.py b/mmrazor/models/losses/kd_soft_ce_loss.py
@@ -2,10 +2,15 @@
 import torch
 import torch.nn as nn
 import torch.nn.functional as F
-from mmcls.models.losses.cross_entropy_loss import soft_cross_entropy
 
 from mmrazor.registry import MODELS
 
+try:
+    from mmcls.models.losses.cross_entropy_loss import soft_cross_entropy
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    soft_cross_entropy = get_placeholder('mmcls')
+
 
 @MODELS.register_module()
 class KDSoftCELoss(nn.Module):

diff --git a/mmrazor/models/ops/efficientnet_series.py b/mmrazor/models/ops/efficientnet_series.py
@@ -2,12 +2,17 @@
 from typing import Dict, Optional
 
 import torch.nn as nn
-from mmcls.models.utils import SELayer
 from mmcv.cnn import ConvModule
 
 from mmrazor.registry import MODELS
 from .base import BaseOP
 
+try:
+    from mmcls.models.utils import SELayer
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    SELayer = get_placeholder('mmcls')
+
 
 @MODELS.register_module()
 class ConvBnAct(BaseOP):

diff --git a/mmrazor/models/ops/mobilenet_series.py b/mmrazor/models/ops/mobilenet_series.py
@@ -1,13 +1,18 @@
 # Copyright (c) OpenMMLab. All rights reserved.
 import torch.nn as nn
 import torch.utils.checkpoint as cp
-from mmcls.models.utils import SELayer
 from mmcv.cnn import ConvModule
 from mmcv.cnn.bricks import DropPath
 
 from mmrazor.registry import MODELS
 from .base import BaseOP
 
+try:
+    from mmcls.models.utils import SELayer
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    SELayer = get_placeholder('mmcls')
+
 
 @MODELS.register_module()
 class MBBlock(BaseOP):

diff --git a/mmrazor/models/ops/shufflenet_series.py b/mmrazor/models/ops/shufflenet_series.py
@@ -2,12 +2,17 @@
 import torch
 import torch.nn as nn
 import torch.utils.checkpoint as cp
-from mmcls.models.utils import channel_shuffle
 from mmcv.cnn import ConvModule, DepthwiseSeparableConvModule
 
 from mmrazor.registry import MODELS
 from .base import BaseOP
 
+try:
+    from mmcls.models.utils import channel_shuffle
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    channel_shuffle = get_placeholder('mmcls')
+
 
 @MODELS.register_module()
 class ShuffleBlock(BaseOP):

diff --git a/mmrazor/structures/tracer/loss_calculator/image_classifier_loss_calculator.py b/mmrazor/structures/tracer/loss_calculator/image_classifier_loss_calculator.py
@@ -1,9 +1,14 @@
 # Copyright (c) OpenMMLab. All rights reserved.
 import torch
-from mmcls.models import ImageClassifier
 
 from mmrazor.registry import TASK_UTILS
 
+try:
+    from mmcls.models import ImageClassifier
+except ImportError:
+    from mmrazor.utils import get_placeholder
+    ImageClassifier = get_placeholder('mmcls')
+
 
 @TASK_UTILS.register_module()
 class ImageClassifierPseudoLoss:

diff --git a/mmrazor/utils/__init__.py b/mmrazor/utils/__init__.py
@@ -1,5 +1,6 @@
 # Copyright (c) OpenMMLab. All rights reserved.
 from .misc import find_latest_checkpoint
+from .placeholder import get_placeholder
 from .setup_env import register_all_modules, setup_multi_processes
 from .typing import (FixMutable, MultiMutatorsRandomSubnet,
                      SingleMutatorRandomSubnet, SupportRandomSubnet,
@@ -8,5 +9,5 @@
 __all__ = [
     'find_latest_checkpoint', 'setup_multi_processes', 'register_all_modules',
     'FixMutable', 'ValidFixMutable', 'SingleMutatorRandomSubnet',
-    'MultiMutatorsRandomSubnet', 'SupportRandomSubnet'
+    'MultiMutatorsRandomSubnet', 'SupportRandomSubnet', 'get_placeholder'
 ]
diff --git a/mmrazor/utils/placeholder.py b/mmrazor/utils/placeholder.py
@@ -0,0 +1,20 @@
+# Copyright (c) OpenMMLab. All rights reserved.
+def get_placeholder(string: str) -> object:
+    """Get placeholder instance which can avoid raising errors when down-stream
+    dependency is not installed properly.
+
+    Args:
+        string (str): the dependency's name, i.e. `mmcls`
+    Raises:
+        ImportError: raise it when the dependency is not installed properly.
+    Returns:
+        object: PlaceHolder instance.
+    """
+
+    class PlaceHolder:
+
+        def __init__(self, *args, **kwargs) -> None:
+            raise ImportError(
+                f'`{string}` is not installed properly, plz check.')
+
+    return PlaceHolder
diff --git a/requirements/mminstall.txt b/requirements/mminstall.txt
@@ -1,2 +1 @@
-mmcls
 mmcv-full>=2.0.0rc0
diff --git a/requirements/optional.txt b/requirements/optional.txt
@@ -1,4 +1,2 @@
 albumentations>=0.3.2
-mmdet
-mmsegmentation
 timm
diff --git a/requirements/readthedocs.txt b/requirements/readthedocs.txt
@@ -1,4 +1,3 @@
-mmcls
 mmcv>=1.3.8
 ordered_set
 torch

diff --git a/requirements/runtime.txt b/requirements/runtime.txt
@@ -1,3 +1,2 @@
-mmcls
 ordered_set
 typing_extensions;python_version<"3.8"
diff --git a/requirements/tests.txt b/requirements/tests.txt
@@ -2,8 +2,6 @@ codecov
 flake8
 interrogate
 isort==4.3.21
-mmdet
-mmsegmentation
 pytest
 xdoctest >= 0.10.0
 yapf