mindstudio-probe 1.0.1__py3-none-any.whl → 1.0.4__py3-none-any.whl

msprobe/mindspore/common/const.py

@@ -0,0 +1,106 @@
+import numpy as np
+import mindspore as ms
+
+from msprobe.core.common.const import Const as CoreConst
+
+
+class Const:
+    CELL = "cell"
+    API = "api"
+    KERNEL = "kernel"
+    TOOL_LEVEL_DICT = {
+        CoreConst.LEVEL_L0: CELL,
+        CoreConst.LEVEL_L1: API,
+        CoreConst.LEVEL_L2: KERNEL
+    }
+    PYNATIVE_MODE = "pynative"
+    GRAPH_GE_MODE = "graph_ge"
+    GRAPH_KBYK_MODE = "graph_kbyk"
+    JIT_LEVEL = "jit_level"
+    JIT_LEVEL_O0 = "O0"
+    JIT_LEVEL_O1 = "O1"
+    JIT_LEVEL_O2 = "O2"
+    ASCEND_910A = "ascend910"
+
+    OPS_PREFIX = "mindspore.ops."
+    Tensor_PREFIX = "mindspore.Tensor."
+    MINT_PREFIX = "mindspore.mint."
+    MINT_NN_FUNC_PREFIX = "mindspore.mint.nn.functional."
+    COMM_PREFIX = "mindspore.communication.comm_func."
+    COMMUNICATION_API_LIST = [
+        "mindspore.communication.comm_func.all_gather_into_tensor",
+        "mindspore.communication.comm_func.gather_into_tensor",
+        "mindspore.communication.comm_func.all_reduce",
+        "mindspore.communication.comm_func.reduce",
+        "mindspore.communication.comm_func.reduce_scatter_tensor"
+        ]
+    TENSOR_DATA_PREFIX = "Tensor."
+    STUB_TENSOR_DATA_PREFIX = "Tensor."
+    OPS_DATA_PREFIX = "Functional."
+    MINT_DATA_PREFIX = "Mint."
+    MINT_NN_FUNC_DATA_PREFIX = "MintFunctional."
+
+    SUPPORTED_API_LIST_FILE = "support_wrap_ops.yaml"
+    SUPPORTED_TENSOR_LIST_KEY = "tensor"
+    SUPPORTED_OPS_LIST_KEY = "ops"
+    SUPPORTED_MINT_LIST_KEY = "mint.ops"
+    SUPPORTED__MINT_NN_FUNC_LIST_KEY = "mint.nn.functional"
+
+    DROPOUT_API_NAME_PREFIX = "dropout"
+
+
+class FreeBenchmarkConst:
+    ADD_NOISE = "add_noise"
+    BIT_NOISE = "bit_noise"
+    NO_CHANGE = "no_change"
+    EXCHANGE_VALUE = "change_value"
+    IMPROVE_PRECISION = "improve_precision"
+    CHECK = "check"
+    FIX = "fix"
+    DEFAULT_DEVICE = "npu"
+    DEFAULT_STAGE = CoreConst.FORWARD
+    DEFAULT_DUMP_LEVEL = "L1"
+    DEFAULT_PERT_TYPE = IMPROVE_PRECISION
+    DEFAULT_HANDLER_TYPE = CHECK
+    DEVICE_LIST = [DEFAULT_DEVICE]
+    STAGE_LIST = [CoreConst.FORWARD]
+    DUMP_LEVEL_LIST = [DEFAULT_DUMP_LEVEL]
+    PERT_TYPE_LIST = [IMPROVE_PRECISION, ADD_NOISE, BIT_NOISE, NO_CHANGE, EXCHANGE_VALUE]
+    HANDLER_TYPE_LIST = [CHECK, FIX]
+    NO_CHANGE_ERROR_THRESHOLD = 1.0
+    SYMBOL_FLIPPING_RATIO = 8.0
+
+    API_PREFIX_DICT = {
+        "ops": Const.OPS_PREFIX,
+        "Tensor": Const.Tensor_PREFIX,
+        "mint": Const.MINT_PREFIX,
+        "mint.nn.functional": Const.MINT_NN_FUNC_PREFIX,
+        "communication": Const.COMM_PREFIX
+    }
+
+    PERT_VALUE_DICT = {
+        ms.bfloat16: 1e-4,
+        ms.float16: 1e-6,
+        ms.float32: 1e-8,
+        ms.float64: 1e-16
+    }
+
+    ERROR_THRESHOLD = {
+        ms.float16: 1.002,
+        ms.float32: 1.0002
+    }
+
+    PERT_BIT_DICT = {
+        ms.float16: np.int16,
+        ms.float32: np.int32,
+        ms.float64: np.int64
+    }
+
+    MS_NUMPY_DTYPE_DICT = {
+        ms.int16: np.int16,
+        ms.int32: np.int32,
+        ms.int64: np.int64,
+        ms.float16: np.float16,
+        ms.float32: np.float32,
+        ms.float64: np.float64
+    }

msprobe/mindspore/common/log.py

@@ -0,0 +1,38 @@
+# Copyright 2024 Huawei Technologies Co., Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============================================================================
+
+import os
+import time
+import sys
+
+from msprobe.mindspore.common.utils import get_rank_if_initialized
+from msprobe.core.common.log import BaseLogger
+from msprobe.core.common.exceptions import DistributedNotInitializedError
+
+
+class MindsporeLogger(BaseLogger):
+    def __init__(self):
+        super().__init__()
+
+    def get_rank(self):
+        try:
+            current_rank = get_rank_if_initialized()
+        except DistributedNotInitializedError:
+            current_rank = None
+
+        return current_rank
+
+
+logger = MindsporeLogger()

msprobe/mindspore/common/utils.py

@@ -0,0 +1,81 @@
+# Copyright 2024 Huawei Technologies Co., Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============================================================================
+import os
+import mindspore as ms
+
+from msprobe.core.common.exceptions import DistributedNotInitializedError
+from msprobe.core.common.file_utils import path_len_exceeds_limit, check_path_exists, save_npy
+from msprobe.core.common.log import logger
+
+
+def get_rank_if_initialized():
+    if ms.communication.GlobalComm.INITED:
+        return ms.communication.get_rank()
+    else:
+        raise DistributedNotInitializedError("mindspore distributed environment is not initialized")
+
+
+def convert_bf16_to_fp32(tensor):
+    if tensor.dtype == ms.bfloat16:
+        tensor = tensor.to(ms.float32)
+    return tensor
+
+
+def save_tensor_as_npy(tensor, file_path):
+    if not path_len_exceeds_limit(file_path):
+        tensor = convert_bf16_to_fp32(tensor)
+        saved_tensor = tensor.asnumpy()
+        save_npy(saved_tensor, file_path)
+    else:
+        logger.warning(f'The file path {file_path} length exceeds limit.')
+
+
+def convert_to_int(value):
+    try:
+        return int(value)
+    except Exception:
+        return -1
+
+
+def list_lowest_level_directories(root_dir):
+    check_path_exists(root_dir)
+    lowest_level_dirs = []
+
+    def recurse_dirs(current_dir):
+        for entry in os.listdir(current_dir):
+            full_path = os.path.join(current_dir, entry)
+            if os.path.isdir(full_path):
+                if any(os.path.isdir(os.path.join(full_path, subentry)) for subentry in os.listdir(full_path)):
+                    recurse_dirs(full_path)
+                else:
+                    lowest_level_dirs.append(full_path)
+
+    recurse_dirs(root_dir)
+    return lowest_level_dirs
+
+
+
+class MsprobeStep(ms.train.Callback):
+
+    def __init__(self, debugger):
+        super(MsprobeStep, self).__init__()
+        self.debugger = debugger
+
+    def on_train_step_begin(self, run_context):
+        self.debugger.start()
+
+    def on_train_step_end(self, run_context):
+        self.debugger.stop()
+        self.debugger.step()

msprobe/mindspore/compare/distributed_compare.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+# Copyright (C) 2019-2024. Huawei Technologies Co., Ltd. All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""
+import os
+from msprobe.core.common.utils import CompareException, check_compare_param, \
+    check_configuration_param, task_dumppath_get
+from msprobe.core.common.file_utils import create_directory
+from msprobe.core.common.exceptions import FileCheckException
+from msprobe.mindspore.common.log import logger
+from msprobe.mindspore.compare.ms_compare import MSComparator
+from msprobe.core.compare.utils import check_and_return_dir_contents, extract_json
+from msprobe.mindspore.compare.ms_graph_compare import GraphMSComparator
+
+def ms_compare_distributed(npu_dump_dir, bench_dump_dir, output_path, **kwargs):
+    if kwargs.get('suffix'):
+        logger.error("Argument 'suffix' is not supported for compare_distributed.")
+        raise CompareException(CompareException.INVALID_PARAM_ERROR)
+    stack_mode = kwargs.get('stack_mode', False)
+    auto_analyze = kwargs.get('auto_analyze', True)
+    fuzzy_match = kwargs.get('fuzzy_match', False)
+    # get the ranks and match by order
+    npu_ranks = sorted(check_and_return_dir_contents(npu_dump_dir, 'rank'))
+    bench_ranks = sorted(check_and_return_dir_contents(bench_dump_dir, 'rank'))
+    if len(npu_ranks) != len(bench_ranks):
+        logger.error('The number of ranks in the two runs are different. '
+                        'Unable to match the ranks. Please use another folder to compare '
+                        'or use compare() api and manually match the ranks.')
+        raise CompareException(CompareException.INVALID_PATH_ERROR)
+    for nr, br in zip(npu_ranks, bench_ranks):
+        npu_data_dir = os.path.join(npu_dump_dir, nr)
+        bench_data_dir = os.path.join(bench_dump_dir, br)
+        npu_path = extract_json(npu_data_dir, stack_json=False)
+        bench_path = extract_json(bench_data_dir, stack_json=False)
+        stack_path = extract_json(npu_data_dir, stack_json=True)
+
+        dump_result_param = {
+            'npu_json_path': npu_path,
+            'bench_json_path': bench_path,
+            'stack_json_path': stack_path,
+            'is_print_compare_log': True
+        }
+        try:
+            summary_compare, md5_compare = task_dumppath_get(dump_result_param)
+            check_configuration_param(stack_mode, auto_analyze, fuzzy_match)
+            create_directory(output_path)
+            check_compare_param(dump_result_param, output_path, summary_compare=summary_compare, md5_compare=md5_compare)
+        except (CompareException, FileCheckException) as error:
+            logger.error('Compare failed. Please check the arguments and do it again!')
+            raise CompareException(error.code) from error
+        ms_comparator = MSComparator()
+        ms_comparator.compare_core(dump_result_param, output_path, suffix=f'_{nr}-{br}', summary_compare=summary_compare,
+                     md5_compare=md5_compare, **kwargs)
+
+
+def ms_graph_compare(inputs, outputs):
+    try:
+        create_directory(outputs)
+    except (CompareException, FileCheckException) as error:
+        logger.error('Compare failed. Please check the arguments and do it again!')
+        return
+    msComparator = GraphMSComparator(inputs, outputs)
+    msComparator.compare_core()

msprobe/mindspore/compare/ms_compare.py

@@ -0,0 +1,219 @@
+import os
+import copy
+from msprobe.core.common.utils import check_compare_param, CompareException, check_configuration_param, \
+    task_dumppath_get
+from msprobe.core.common.file_utils import create_directory, load_yaml, load_npy
+from msprobe.core.common.const import Const, CompareConst
+from msprobe.core.common.log import logger
+from msprobe.core.common.exceptions import FileCheckException
+from msprobe.core.compare.acc_compare import Comparator
+from msprobe.core.compare.check import check_struct_match, fuzzy_check_op
+
+
+class MSComparator(Comparator):
+    def __init__(self, cell_mapping=None, api_mapping=None):
+        self.frame_name = MSComparator.__name__
+        self.cell_mapping = cell_mapping
+        self.api_mapping = api_mapping
+        self.cross_frame = cell_mapping is not None or api_mapping is not None
+        self.cell_mapping_dict = self.load_mapping_file(self.cell_mapping)
+        self.api_mapping_dict = self.load_mapping_file(self.api_mapping)
+        if api_mapping is not None:
+            self.ms_to_pt_mapping = self.load_internal_api()
+            
+    def load_internal_api(self):
+        cur_path = os.path.dirname(os.path.realpath(__file__))
+        yaml_path = os.path.join(cur_path,"ms_to_pt_api.yaml")
+        return load_yaml(yaml_path)
+
+    def load_mapping_file(self, mapping_file):
+        if isinstance(mapping_file, str):
+            mapping_dict = load_yaml(mapping_file)
+        else:
+            mapping_dict = {}
+        return mapping_dict
+
+    def process_cell_mapping(self, npu_op_name):
+        npu_op_name = [op_name.replace("Cell", "Module", 1) for op_name in npu_op_name]
+        if self.cell_mapping_dict:
+            for index, op_name in enumerate(npu_op_name):
+                # get cell name & class name from op_name
+                # Cell.fc1.Dense.forward.0.input.0
+                cell_name = op_name.split(Const.SEP, 1)[-1].rsplit(Const.SEP, 4)[0]
+                if cell_name in self.cell_mapping_dict:
+                    npu_op_name[index] = op_name.replace(cell_name, self.cell_mapping_dict[cell_name], 1)
+        return npu_op_name
+
+    def check_op(self, npu_dict, bench_dict, fuzzy_match):
+        npu_dict_new, bench_dict_new = copy.deepcopy(npu_dict), copy.deepcopy(bench_dict)  
+        npu_op_name, bench_op_name = npu_dict_new.get(CompareConst.OP_NAME), bench_dict_new.get(CompareConst.OP_NAME)
+        if self.cell_mapping is not None:
+            npu_op_name = self.process_cell_mapping(npu_op_name)
+        if self.api_mapping is not None:
+            npu_op_name = self.process_internal_api_mapping(npu_op_name, bench_op_name)
+            if isinstance(self.api_mapping, str):
+                npu_dict_new, bench_dict_new, target_dict = self.transform_user_mapping_api(npu_dict_new, bench_dict_new)
+                if target_dict:
+                    bench_dict = self.reconstitution_bench_dict(npu_dict, copy.deepcopy(bench_dict_new), target_dict)
+                    npu_op_name, bench_op_name = npu_dict_new.get(CompareConst.OP_NAME), bench_dict_new.get(CompareConst.OP_NAME)
+        struct_match = check_struct_match(npu_dict_new, bench_dict_new, cross_frame=self.cross_frame)
+        if not fuzzy_match:
+            return npu_op_name == bench_op_name and struct_match
+        is_match = True
+        try:
+            is_match = fuzzy_check_op(npu_op_name, bench_op_name)
+        except Exception as err:
+            logger.warning("%s and %s can not fuzzy match." % (npu_op_name, bench_op_name))
+            is_match = False
+        return is_match and struct_match
+    
+    def read_npy_data(self, dir_path, file_name, load_pt_file=False):
+        data_path = os.path.join(dir_path, file_name)
+        if load_pt_file:
+            import torch
+            from msprobe.pytorch.common.utils import load_pt
+            data_value = load_pt(data_path).detach()
+            if data_value.dtype == torch.bfloat16:
+                data_value = data_value.to(torch.float32)
+            data_value = data_value.numpy()
+        else:
+            data_value = load_npy(data_path) 
+        return data_value    
+
+    def api_replace(self, npu_op_name, target, para):
+        for idx, _ in enumerate(npu_op_name):
+            npu_op_name[idx] = npu_op_name[idx].replace(target, para)
+        return npu_op_name
+    
+    def process_internal_api_mapping(self, npu_op_name, bench_op_name):
+        # get api name & class name from op_name
+        # Functional.addcmul.0.forward.input.0
+        npu_op_name, bench_op_name = npu_op_name.copy(), bench_op_name.copy()
+        ms_api_name = self.get_api_name(npu_op_name[0].split(Const.SEP))
+        pt_api_name = self.get_api_name(bench_op_name[0].split(Const.SEP))
+        class_name = ms_api_name.split(Const.SEP)[0]
+        if class_name == "Mint":
+            return self.api_replace(npu_op_name, "Mint", "Torch")
+        elif class_name == "MintFunctional":
+            return self.api_replace(npu_op_name, "MintFunctional", "Functional")
+        elif self.ms_to_pt_mapping.get(ms_api_name) == pt_api_name:
+            return self.api_replace(npu_op_name, ms_api_name, pt_api_name)
+        else:
+            return npu_op_name      
+    
+    def remove_element(self, op_name, struct, summary, idx):
+        del op_name[idx]
+        del struct[idx]
+        del summary[idx]
+    
+    def get_api_name(self, api_list):
+        return api_list[0] + Const.SEP + api_list[1]
+    
+    def transform_user_mapping_api(self, new_npu_dict, new_bench_dict):
+        """
+        Transform user mapping API based on new NPU and benchmark dictionaries.
+        Parameters:
+            new_npu_dict (dict): New NPU operation dictionary.
+            new_bench_dict (dict): New benchmark operation dictionary.
+        Returns:
+            tuple: Updated NPU and benchmark dictionaries, along with the target dictionary.
+        """
+        npu_op_name, bench_op_name = new_npu_dict.get(CompareConst.OP_NAME), new_bench_dict.get(CompareConst.OP_NAME)
+        npu_struct_in, bench_struct_in = new_npu_dict.get(CompareConst.INPUT_STRUCT), new_bench_dict.get(CompareConst.INPUT_STRUCT)
+        npu_struct_out, bench_struct_out = new_npu_dict.get(CompareConst.OUTPUT_STRUCT), new_bench_dict.get(CompareConst.OUTPUT_STRUCT)
+        npu_summary, bench_summary = new_npu_dict.get(CompareConst.SUMMARY), new_bench_dict.get(CompareConst.SUMMARY)
+        npu_in_len, bench_in_len, npu_out_len, bench_out_len  = len(npu_struct_in), len(bench_struct_in), len(npu_struct_out), len(bench_struct_out)
+        ms_api_list, pt_api_list = npu_op_name[0].split(Const.SEP), bench_op_name[0].split(Const.SEP)
+        ms_api_name = self.get_api_name(ms_api_list)
+        pt_api_name = self.get_api_name(pt_api_list)
+        target_dict = {}
+        for api_dict in self.api_mapping_dict:
+            if api_dict.get("pt_api") == pt_api_name and api_dict.get("ms_api") == ms_api_name:
+                ms_user_args_len, pt_user_args_len = len(api_dict.get("ms_args")), len(api_dict.get("pt_args"))
+                ms_user_output_len, pt_user_output_len  = len(api_dict.get("ms_output")), len(api_dict.get("pt_output"))
+                if ms_user_args_len != pt_user_args_len or ms_user_output_len != pt_user_output_len:
+                    logger.warning("The user-defined mapping table is incorrect, make sure that the number of parameters is equal" )
+                    break
+                ms_out_list = api_dict.get("ms_output", [])
+                for idx in reversed(range(npu_out_len)):
+                    if idx not in ms_out_list:
+                        del npu_struct_out[idx]
+                        del npu_summary[idx + npu_in_len]
+                        del npu_op_name[idx + npu_in_len]
+                pt_out_list = api_dict.get("pt_output", [])
+                for idx in reversed(range(bench_out_len)):
+                    if idx not in pt_out_list:
+                        del bench_struct_out[idx]
+                        del bench_summary[idx + bench_in_len]
+                        del bench_op_name[idx + bench_in_len]
+                ms_para_list = api_dict.get("ms_args", []) 
+                for idx in reversed(range(npu_in_len)):
+                    if idx not in ms_para_list:
+                        self.remove_element(npu_op_name, npu_struct_in, npu_summary, idx)
+                pt_para_list = api_dict.get("pt_args", []) 
+                for idx in reversed(range(bench_in_len)):
+                    if idx not in pt_para_list:
+                        self.remove_element(bench_op_name, bench_struct_in, bench_summary, idx)
+                npu_op_name = self.api_replace(npu_op_name, ms_api_name, pt_api_name)
+                npu_op_name = self.para_sequence_update(npu_op_name, bench_op_name)
+                target_dict = api_dict
+                break
+        if target_dict:
+            new_npu_dict.update({CompareConst.OP_NAME: npu_op_name, CompareConst.INPUT_STRUCT: npu_struct_in, CompareConst.OUTPUT_STRUCT: npu_struct_out, CompareConst.SUMMARY: npu_summary})
+            new_bench_dict.update({CompareConst.OP_NAME: bench_op_name, CompareConst.INPUT_STRUCT: bench_struct_in, CompareConst.OUTPUT_STRUCT: bench_struct_out, CompareConst.SUMMARY: bench_summary})
+        return new_npu_dict, new_bench_dict, target_dict  
+    
+    def para_sequence_update(self, npu_op_name, bench_op_name):
+        for idx, _ in enumerate(npu_op_name):
+            bench_op_name_list = bench_op_name[idx].rsplit(Const.SEP, 1)
+            if len(bench_op_name_list) != 0:
+                npu_op_name[idx] = npu_op_name[idx][:-1] + bench_op_name_list[-1]
+        return npu_op_name
+
+    def reconstitution_bench_dict(self, npu_dict, del_bench_dict, api_dict):
+        ms_user_args_list = api_dict.get("ms_args", [])
+        ms_user_output_list = api_dict.get("ms_output", [])
+        npu_struct_in = npu_dict.get(CompareConst.INPUT_STRUCT)
+        npu_struct_out = npu_dict.get(CompareConst.OUTPUT_STRUCT)
+        npu_in_len = len(npu_struct_in)
+        npu_out_len = len(npu_struct_out)
+        if npu_in_len == len(ms_user_args_list) and npu_out_len == len(ms_user_output_list):
+            return del_bench_dict
+        ms_input_args_list = [i for i in range(npu_in_len)]
+        input_sub_list =list(set(ms_input_args_list) - set(ms_user_args_list))
+        ms_output_args_list = [i for i in range(npu_out_len)]
+        output_sub_list =list(set(ms_output_args_list) - set(ms_user_output_list))
+        bench_op_name = del_bench_dict.get(CompareConst.OP_NAME, [])
+        bench_struct_in = del_bench_dict.get(CompareConst.INPUT_STRUCT, [])
+        bench_struct_out = del_bench_dict.get(CompareConst.OUTPUT_STRUCT, [])
+        bench_summary = del_bench_dict.get(CompareConst.SUMMARY, [])
+        for idx in input_sub_list:  # Fill in the blank value field in the pt dictionary
+            bench_op_name.insert(idx, CompareConst.NAN)
+            bench_struct_in.insert(idx, CompareConst.NAN)
+            bench_summary.insert(idx, CompareConst.NAN)
+        for idx in output_sub_list:  # Fill in the blank value field in the pt dictionary
+            bench_op_name.insert(npu_in_len + idx, CompareConst.NAN)
+            bench_struct_out.insert(idx, CompareConst.NAN)
+            bench_summary.insert(npu_in_len + idx, CompareConst.NAN)
+        del_bench_dict.update({CompareConst.OP_NAME: bench_op_name, CompareConst.INPUT_STRUCT: bench_struct_in, CompareConst.OUTPUT_STRUCT: bench_struct_out, CompareConst.SUMMARY: bench_summary})
+        return del_bench_dict
+        
+        
+def ms_compare(input_param, output_path, **kwargs):
+    try:
+        stack_mode = kwargs.get('stack_mode', False)
+        auto_analyze = kwargs.get('auto_analyze', True)
+        fuzzy_match = kwargs.get('fuzzy_match', False)
+        cell_mapping = kwargs.get('cell_mapping', None)
+        api_mapping = kwargs.get('api_mapping', None)
+        summary_compare, md5_compare = task_dumppath_get(input_param)
+        check_configuration_param(stack_mode, auto_analyze, fuzzy_match)
+        create_directory(output_path)
+        check_compare_param(input_param, output_path, summary_compare, md5_compare)
+    except (CompareException, FileCheckException) as error:
+        logger.error('Compare failed. Please check the arguments and do it again!')
+        raise CompareException(error.code) from error
+    ms_comparator = MSComparator(cell_mapping, api_mapping)
+    ms_comparator.compare_core(input_param, output_path, stack_mode=stack_mode,
+                 auto_analyze=auto_analyze, fuzzy_match=fuzzy_match, summary_compare=summary_compare,
+                 md5_compare=md5_compare)