Fix docstring format (#495)

* Fix doc common * Fix bugs
open-mmlab · May 23, 2022 · de3f18f · de3f18f
1 parent 57baf21
commit de3f18f
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 26 deletions.
diff --git a/mmdeploy/apis/calibration.py b/mmdeploy/apis/calibration.py
@@ -24,15 +24,15 @@ def create_calib_table(calib_file: str,
     Examples:
         >>> from mmdeploy.apis import create_calib_table
         >>> from mmdeploy.utils import get_calib_filename, load_config
-        >>> deploy_cfg = 'configs/mmdet/detection/' \
-            'detection_tensorrt-int8_dynamic-320x320-1344x1344.py'
+        >>> deploy_cfg = ('configs/mmdet/detection/'
+                          'detection_tensorrt-int8_dynamic-320x320-1344x1344.py')
         >>> deploy_cfg = load_config(deploy_cfg)[0]
         >>> calib_file = get_calib_filename(deploy_cfg)
-        >>> model_cfg = 'mmdetection/configs/fcos/' \
-            'fcos_r50_caffe_fpn_gn-head_1x_coco.py'
-        >>> model_checkpoint = 'checkpoints/' \
-            'fcos_r50_caffe_fpn_gn-head_1x_coco-821213aa.pth'
-        >>> create_calib_table(calib_file, deploy_cfg, \
+        >>> model_cfg = ('mmdetection/configs/fcos/'
+                         'fcos_r50_caffe_fpn_gn-head_1x_coco.py')
+        >>> model_checkpoint = ('checkpoints/'
+                                'fcos_r50_caffe_fpn_gn-head_1x_coco-821213aa.pth')
+        >>> create_calib_table(calib_file, deploy_cfg,
             model_cfg, model_checkpoint, device='cuda:0')
 
     Args:

diff --git a/mmdeploy/apis/inference.py b/mmdeploy/apis/inference.py
@@ -16,15 +16,15 @@ def inference_model(model_cfg: Union[str, mmcv.Config],
 
     Examples:
         >>> from mmdeploy.apis import inference_model
-        >>> model_cfg = 'mmdetection/configs/fcos/' \
-            'fcos_r50_caffe_fpn_gn-head_1x_coco.py'
-        >>> deploy_cfg = 'configs/mmdet/detection/' \
-            'detection_onnxruntime_dynamic.py'
+        >>> model_cfg = ('mmdetection/configs/fcos/'
+                         'fcos_r50_caffe_fpn_gn-head_1x_coco.py')
+        >>> deploy_cfg = ('configs/mmdet/detection/'
+                          'detection_onnxruntime_dynamic.py')
         >>> backend_files = ['work_dir/fcos.onnx']
         >>> img = 'demo.jpg'
         >>> device = 'cpu'
-        >>> model_output = inference_model(model_cfg, deploy_cfg, \
-            backend_files, img, device)
+        >>> model_output = inference_model(model_cfg, deploy_cfg,
+                            backend_files, img, device)
 
     Args:
         model_cfg (str | mmcv.Config): Model config file or Config object.

diff --git a/mmdeploy/apis/pytorch2onnx.py b/mmdeploy/apis/pytorch2onnx.py
@@ -69,12 +69,12 @@ def torch2onnx(img: Any,
         >>> img = 'demo.jpg'
         >>> work_dir = 'work_dir'
         >>> save_file = 'fcos.onnx'
-        >>> deploy_cfg = 'configs/mmdet/detection/' \
-            'detection_onnxruntime_dynamic.py'
-        >>> model_cfg = 'mmdetection/configs/fcos/' \
-            'fcos_r50_caffe_fpn_gn-head_1x_coco.py'
-        >>> model_checkpoint = 'checkpoints/' \
-            'fcos_r50_caffe_fpn_gn-head_1x_coco-821213aa.pth'
+        >>> deploy_cfg = ('configs/mmdet/detection/'
+                          'detection_onnxruntime_dynamic.py')
+        >>> model_cfg = ('mmdetection/configs/fcos/'
+                         'fcos_r50_caffe_fpn_gn-head_1x_coco.py')
+        >>> model_checkpoint = ('checkpoints/'
+                                'fcos_r50_caffe_fpn_gn-head_1x_coco-821213aa.pth')
         >>> device = 'cpu'
         >>> torch2onnx(img, work_dir, save_file, deploy_cfg, \
             model_cfg, model_checkpoint, device)

diff --git a/mmdeploy/apis/visualize.py b/mmdeploy/apis/visualize.py
@@ -21,10 +21,10 @@ def visualize_model(model_cfg: Union[str, mmcv.Config],
 
     Examples:
         >>> from mmdeploy.apis import visualize_model
-        >>> model_cfg = 'mmdetection/configs/fcos/' \
-            'fcos_r50_caffe_fpn_gn-head_1x_coco.py'
-        >>> deploy_cfg = 'configs/mmdet/detection/' \
-            'detection_onnxruntime_dynamic.py'
+        >>> model_cfg = ('mmdetection/configs/fcos/'
+                         'fcos_r50_caffe_fpn_gn-head_1x_coco.py')
+        >>> deploy_cfg = ('configs/mmdet/detection/'
+                          'detection_onnxruntime_dynamic.py')
         >>> model = 'work_dir/fcos.onnx'
         >>> img = 'demo.jpg'
         >>> device = 'cpu'

diff --git a/mmdeploy/backend/tensorrt/onnx2tensorrt.py b/mmdeploy/backend/tensorrt/onnx2tensorrt.py
@@ -26,10 +26,10 @@ def onnx2tensorrt(work_dir: str,
         >>> work_dir = 'work_dir'
         >>> save_file = 'end2end.engine'
         >>> model_id = 0
-        >>> deploy_cfg = 'configs/mmdet/detection/' \
-                'detection_tensorrt_dynamic-320x320-1344x1344.py'
+        >>> deploy_cfg = ('configs/mmdet/detection/'
+                          'detection_tensorrt_dynamic-320x320-1344x1344.py')
         >>> onnx_model = 'work_dir/end2end.onnx'
-        >>> onnx2tensorrt(work_dir, save_file, model_id, deploy_cfg, \
+        >>> onnx2tensorrt(work_dir, save_file, model_id, deploy_cfg,
                 onnx_model, 'cuda:0')
 
     Args: