Compitable old interface (#404)

* compitable-old-interface

* compitable softnms

* rename

* rename

* use warnings

* upgrade version to 1.0.1

mmcv/ops/nms.py

 import numpy as np
 import torch
 
+from mmcv.utils import deprecated_api_warning
 from ..utils import ext_loader
 
 ext_module = ext_loader.load_ext('_ext', ['nms', 'softnms', 'nms_match'])
 
 
+@deprecated_api_warning({'iou_thr': 'iou_threshold'})
 def nms(boxes, scores, iou_threshold, offset=0):
     """Dispatch to either CPU or GPU NMS implementations.
 
@@ -85,6 +87,7 @@ def nms(boxes, scores, iou_threshold, offset=0):
     return dets, inds
 
 
+@deprecated_api_warning({'iou_thr': 'iou_threshold'})
 def soft_nms(boxes,
              scores,
              iou_threshold=0.3,

mmcv/ops/roi_align.py

@@ -3,7 +3,7 @@ from torch.autograd import Function
 from torch.autograd.function import once_differentiable
 from torch.nn.modules.utils import _pair
 
-from ..utils import ext_loader
+from ..utils import deprecated_api_warning, ext_loader
 
 ext_module = ext_loader.load_ext('_ext',
                                  ['roi_align_forward', 'roi_align_backward'])
@@ -131,6 +131,12 @@ class RoIAlign(nn.Module):
         performance if ROIAlign is used together with conv layers.
     """
 
+    @deprecated_api_warning(
+        {
+            'out_size': 'output_size',
+            'sample_num': 'sampling_ratio'
+        },
+        cls_name='RoIAlign')
     def __init__(self,
                  output_size,
                  spatial_scale=1.0,

mmcv/utils/__init__.py

 # flake8: noqa
 # Copyright (c) Open-MMLab. All rights reserved.
 from .config import Config, ConfigDict, DictAction
-from .misc import (check_prerequisites, concat_list, is_list_of, is_seq_of,
-                   is_str, is_tuple_of, iter_cast, list_cast,
-                   requires_executable, requires_package, slice_list,
-                   tuple_cast)
+from .misc import (check_prerequisites, concat_list, deprecated_api_warning,
+                   is_list_of, is_seq_of, is_str, is_tuple_of, iter_cast,
+                   list_cast, requires_executable, requires_package,
+                   slice_list, tuple_cast)
 from .path import (check_file_exist, fopen, is_filepath, mkdir_or_exist,
                    scandir, symlink)
 from .progressbar import (ProgressBar, track_iter_progress,
@@ -21,7 +21,7 @@ except ImportError:
         'requires_executable', 'is_filepath', 'fopen', 'check_file_exist',
         'mkdir_or_exist', 'symlink', 'scandir', 'ProgressBar',
         'track_progress', 'track_iter_progress', 'track_parallel_progress',
-        'Timer', 'TimerError', 'check_time'
+        'Timer', 'TimerError', 'check_time', 'deprecated_api_warning'
     ]
 else:
     from .env import TORCH_VERSION
@@ -46,5 +46,5 @@ else:
         '_AvgPoolNd', '_BatchNorm', '_ConvNd', '_ConvTransposeMixin',
         '_InstanceNorm', '_MaxPoolNd', 'get_build_config', 'BuildExtension',
         'CppExtension', 'CUDAExtension', 'DataLoader', 'PoolDataLoader',
-        'TORCH_VERSION'
+        'TORCH_VERSION', 'deprecated_api_warning'
     ]

mmcv/utils/misc.py

@@ -2,8 +2,10 @@
 import functools
 import itertools
 import subprocess
+import warnings
 from collections import abc
 from importlib import import_module
+from inspect import getfullargspec
 
 
 def is_str(x):
@@ -213,3 +215,53 @@ def requires_executable(prerequisites):
         1
     """
     return check_prerequisites(prerequisites, checker=_check_executable)
+
+
+def deprecated_api_warning(name_dict, cls_name=None):
+    """A decorator to check if some argments are deprecate and try to replace
+    deprecate src_arg_name to dst_arg_name.
+
+    Args:
+        name_dict(dict):
+            key (str): Deprecate argument names.
+            val (str): Expected argument names.
+
+    Returns:
+        func: New function.
+    """
+
+    def api_warning_wrapper(old_func):
+
+        @functools.wraps(old_func)
+        def new_func(*args, **kwargs):
+            # get the arg spec of the decorated method
+            args_info = getfullargspec(old_func)
+            # get name of the function
+            func_name = old_func.__name__
+            if cls_name is not None:
+                func_name = f'{cls_name}.{func_name}'
+            if args:
+                arg_names = args_info.args[:len(args)]
+                for src_arg_name, dst_arg_name in name_dict.items():
+                    if src_arg_name in arg_names:
+                        warnings.warn(
+                            f'"{src_arg_name}" is deprecated in '
+                            f'`{func_name}`, please use "{dst_arg_name}" '
+                            'instead')
+                        arg_names[arg_names.index(src_arg_name)] = dst_arg_name
+            if kwargs:
+                for src_arg_name, dst_arg_name in name_dict.items():
+                    if src_arg_name in kwargs:
+                        warnings.warn(
+                            f'"{src_arg_name}" is deprecated in '
+                            f'`{func_name}`, please use "{dst_arg_name}" '
+                            'instead')
+                        kwargs[dst_arg_name] = kwargs.pop(src_arg_name)
+
+            # apply converted arguments to the decorated method
+            output = old_func(*args, **kwargs)
+            return output
+
+        return new_func
+
+    return api_warning_wrapper

mmcv/version.py

 # Copyright (c) Open-MMLab. All rights reserved.
-__version__ = '1.0.0'
+__version__ = '1.0.1'