mindstudio-probe 8.3.3__py3-none-any.whl → 26.0.0a1__py3-none-any.whl

msprobe/msaccucmp/algorithm_manager/algorithm_manager.py

@@ -0,0 +1,464 @@
+# coding=utf-8
+# -------------------------------------------------------------------------
+#  This file is part of the MindStudio project.
+# Copyright (c) 2025 Huawei Technologies Co.,Ltd.
+#
+# MindStudio is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan PSL v2.
+# You may obtain a copy of Mulan PSL v2 at:
+#
+#          http://license.coscl.org.cn/MulanPSL2
+#
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+# EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+# MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+# -------------------------------------------------------------------------
+
+"""
+Function:
+AlgorithmManager class.
+This class mainly involves the compare function.
+"""
+import os
+import re
+import sys
+import time
+import stat
+import importlib
+
+import numpy as np
+
+from msprobe.msaccucmp.cmp_utils import log, utils_type
+from msprobe.msaccucmp.cmp_utils import utils, path_check
+from msprobe.msaccucmp.algorithm_manager.algorithm_parameter import AlgorithmParameter
+from msprobe.msaccucmp.cmp_utils.constant.const_manager import ConstManager
+from msprobe.msaccucmp.cmp_utils.reg_manager import RegManager
+from msprobe.msaccucmp.cmp_utils.constant.compare_error import CompareError
+from msprobe.msaccucmp.cmp_utils.file_utils import FileUtils
+from msprobe.msaccucmp.dump_parse import dump_utils
+
+
+class AlgorithmManager:
+    """
+    The class for algorithm manager
+    """
+
+    def __init__(self: any, custom_script_path: str, select_algorithm: object, algorithm_options: str) -> None:
+        self.custom_path = custom_script_path
+        self.built_in_support_algorithm = []
+        self.custom_support_algorithm = []
+        self._make_support_algorithm()
+        self.select_algorithm_list = self._parse_selection_algorithm(select_algorithm)
+        self.algorithm_param = self._parse_algorithm_argument(algorithm_options)
+        self.support_algorithm_map = self._make_select_algorithm_map()
+
+    @staticmethod
+    def _check_value_invalid(value: object, parameter: str) -> None:
+        is_list_value_invalid = isinstance(value, list) and len(value) != 2
+        if not value or is_list_value_invalid:
+            log.print_error_log('The algorithm argument (%r) is invalid, just supports '
+                                '"algorithm_name:name1=value1,name2=value2;".' % parameter)
+            raise CompareError(CompareError.MSACCUCMP_INVALID_PARAM_ERROR)
+
+    @staticmethod
+    def _update_algorithm_param(algorithm_name: str, algorithm_param: dict, param_map: dict) -> None:
+        if RegManager.match_pattern(RegManager.BUILTIN_ALGORITHM_INDEX_PATTERN, algorithm_name):
+            algorithm_name = ConstManager.BUILT_IN_ALGORITHM[int(algorithm_name)]
+        if algorithm_name in algorithm_param:
+            algorithm_param[algorithm_name] = dict(algorithm_param.get(algorithm_name), **param_map)
+        else:
+            algorithm_param[algorithm_name] = param_map
+
+    @staticmethod
+    def _get_function(algorithm_module: any, module_type: str) -> (bool, any):
+        algorithm_func = getattr(algorithm_module, ConstManager.COMPARE_FUNC_NAME)
+        # check compare is function
+        if not callable(algorithm_func):
+            log.print_warn_log("[%s] The '%s' in %s is not function. Please check the file." %
+                               (module_type, ConstManager.COMPARE_FUNC_NAME, str(algorithm_module.__file__)))
+            return False, ''
+
+        # check argument count of compare
+        if algorithm_func.__code__.co_argcount != ConstManager.COMPARE_ARGUMENT_COUNT:
+            log.print_warn_log("[%s] The argument count (%d) of '%s' in %s is not %d. Please check the file." %
+                               (module_type, algorithm_func.__code__.co_argcount, ConstManager.COMPARE_FUNC_NAME,
+                                str(algorithm_module.__file__), ConstManager.COMPARE_ARGUMENT_COUNT))
+            return False, ''
+        return True, algorithm_func
+
+    @staticmethod
+    def _add_algorithm_file_to_list(file_path: str, support_algorithm_list: list) -> bool:
+        if os.path.isfile(file_path):
+            file_name_pattern = re.compile(ConstManager.ALGORITHM_FILE_NAME_PATTERN)
+            match = file_name_pattern.match(os.path.basename(file_path))
+            if match is not None:
+                file_stat = os.stat(file_path)
+                file_mode = file_stat.st_mode
+                # 判断others或group权限是否有写权限
+                if bool(file_mode & stat.S_IWGRP):
+                    log.print_warn_log(f"File {file_path} is not safe. Groups have writing permission to this file.")
+                if bool(file_mode & stat.S_IWOTH):
+                    log.print_error_log(f"File {file_path} is dangerous. Others have writing "
+                                        "permission to this file. Please use chmod to dismiss the writing permission.")
+                    raise CompareError(CompareError.MSACCUCMP_DANGER_FILE_ERROR)
+                support_algorithm_list.append(match.group(1))
+                current_uid = os.getuid()
+                # 判断当前用户是普通用户情况下，文件创建者是否是当前用户
+                if current_uid != 0 and file_stat.st_uid != 0 and file_stat.st_uid != current_uid:
+                    log.print_error_log(f"File {file_path} is not owned by current user, "
+                                        "if must use this file, copy or chmod this file by yourself.")
+                    raise CompareError(CompareError.MSACCUCMP_DANGER_FILE_ERROR)
+                return True
+            log.print_warn_log("The file '%r' does not match 'alg_{algorithm_name}.py'"
+                               " in '%r', please check the file." % (os.path.basename(file_path),
+                                                                     os.path.dirname(file_path)))
+        return False
+
+    @staticmethod
+    def _check_data_size_valid(my_output_dump_data: any, ground_truth_dump_data: any, args: dict) -> None:
+        my_output_dump_data_size = len(my_output_dump_data)
+        if my_output_dump_data_size == 0 and args.get('my_output_dump_file') is not None:
+            msg = 'The dump data size is 0 in %r.' % args.get('my_output_dump_file')
+            log.print_warn_log(msg)
+        ground_truth_dump_data_size = len(ground_truth_dump_data)
+        if ground_truth_dump_data_size == 0 and args.get('ground_truth_dump_file') is not None:
+            msg = 'The dump data size is 0 in %r.' % args.get('ground_truth_dump_file')
+            log.print_warn_log(msg)
+
+        if my_output_dump_data_size != ground_truth_dump_data_size \
+                and args.get('my_output_dump_file') is not None \
+                and args.get('ground_truth_dump_file') is not None:
+            msg = "The my output dump data size (%d) in '%r' does not match the ground truth dump data size (%d) " \
+                  "in '%r'." % (my_output_dump_data_size, args.get('my_output_dump_file'),
+                                ground_truth_dump_data_size, args.get('ground_truth_dump_file'))
+            log.print_warn_log(msg)
+            raise CompareError(CompareError.MSACCUCMP_INVALID_DUMP_DATA_ERROR, msg)
+
+    @staticmethod
+    def _check_return_value_valid(value: object, select_algorithm: str) -> None:
+        # check the return value is string
+        if not isinstance(value, str):
+            err_msg = "The return value (%s) of '%s' in '%s' is not string. Please check the return value." \
+                      % (value, ConstManager.COMPARE_FUNC_NAME, select_algorithm)
+            raise CompareError(ConstManager.COMPARE_FUNC_NAME, err_msg)
+
+    def compare(self: any, my_output_dump_data: any, ground_truth_dump_data: any,
+                args: dict, max_cmp_size: int = 0) -> (list, list):
+        """
+        Compare my output dump data and the ground truth dump data by select algorithm
+        :param my_output_dump_data: my output dump data to compare
+        :param ground_truth_dump_data: the ground truth dump data to compare
+        :param args: the algorithm parameter
+        :param max_cmp_size: max cmp array size
+        :return the result list and compare_fail_message
+        """
+        self._check_data_size_valid(my_output_dump_data, ground_truth_dump_data, args)
+        np.seterr(divide='ignore', invalid='ignore')
+        result = []
+        error_msg = []
+
+        is_bool_data = my_output_dump_data.dtype == np.bool_ and ground_truth_dump_data.dtype == np.bool_
+        if max_cmp_size:
+            my_output_dump_data_to_cmp = my_output_dump_data[:max_cmp_size]
+            ground_truth_dump_data_to_cmp = ground_truth_dump_data[:max_cmp_size]
+        else:
+            my_output_dump_data_to_cmp = my_output_dump_data
+            ground_truth_dump_data_to_cmp = ground_truth_dump_data
+
+        if not is_bool_data:
+            my_output_dump_data_to_cmp = np.array(my_output_dump_data_to_cmp).astype("float32")
+            ground_truth_dump_data_to_cmp = np.array(ground_truth_dump_data_to_cmp).astype("float32")
+
+        for select_algorithm, compare_func in self.support_algorithm_map.items():
+            if is_bool_data and select_algorithm not in ConstManager.BOOL_ALGORITHM:
+                result.append(ConstManager.NAN)
+                error_msg += ["Algorithm %s does not support Boolean types." % select_algorithm]
+                continue
+
+            alg_args = self._make_algorithm_param(select_algorithm, args)
+
+            # call compare function
+            alg_result, alg_error_msg = self._call_compare_function(
+                compare_func, my_output_dump_data_to_cmp, ground_truth_dump_data_to_cmp, alg_args, select_algorithm)
+            result.append(alg_result)
+            if alg_error_msg:
+                error_msg += [alg_error_msg]
+        return result, error_msg
+
+    def get_result_title(self: any) -> list:
+        """
+        Get algorithm name list
+        :return: the list
+        """
+        return list(self.support_algorithm_map.keys())
+
+    def make_nan_result(self: any) -> list:
+        """
+        Make nan result for compare algorithm
+        :return: the list, result is nan
+        """
+        return [ConstManager.NAN] * len(self.support_algorithm_map)
+
+    def _add_algorithm_name_to_list(self: any, algorithm_name: str, select_algorithm_list: list) -> None:
+        if not algorithm_name:
+            return
+        if RegManager.match_pattern(RegManager.BUILTIN_ALGORITHM_INDEX_PATTERN, algorithm_name):
+            if ConstManager.BUILT_IN_ALGORITHM[int(algorithm_name)] not in select_algorithm_list:
+                select_algorithm_list.append(ConstManager.BUILT_IN_ALGORITHM[int(algorithm_name)])
+            return
+        if algorithm_name not in self.built_in_support_algorithm + self.custom_support_algorithm:
+            log.print_warn_log("The '%s' does not supported in builtin or custom. Please check the "
+                               "algorithm name or algorithm index." % algorithm_name)
+            return
+        if algorithm_name not in select_algorithm_list:
+            select_algorithm_list.append(algorithm_name)
+
+    def _make_all_algorithm_list(self: any, select_algorithm: str) -> list:
+        select_algorithm_list = []
+        if select_algorithm.lower() == 'all':
+            select_algorithm_list = ConstManager.BUILT_IN_ALGORITHM
+            for item in self.custom_support_algorithm:
+                if item not in self.custom_support_algorithm:
+                    select_algorithm_list.append(item)
+            return select_algorithm_list
+        return select_algorithm_list
+
+    def _parse_selection_algorithm(self: any, select_algorithm: object) -> list:
+        if not select_algorithm:
+            log.print_error_log('There is no algorithm to select. Please select at least one algorithm.')
+            raise CompareError(CompareError.MSACCUCMP_INVALID_PARAM_ERROR)
+        if isinstance(select_algorithm, list):
+            select_algorithm = ','.join(str(x) for x in select_algorithm)
+
+        select_algorithm_list = self._make_all_algorithm_list(select_algorithm)
+        if select_algorithm_list:
+            return select_algorithm_list
+        for item in select_algorithm.split(','):
+            self._add_algorithm_name_to_list(item.strip(), select_algorithm_list)
+        if not select_algorithm_list:
+            log.print_error_log(
+                "The algorithm in '%s' does not supported. Just supports %s. Please check the "
+                "select algorithm name." % (select_algorithm,
+                                            self.built_in_support_algorithm + self.custom_support_algorithm))
+            raise CompareError(CompareError.MSACCUCMP_INVALID_ALGORITHM_ERROR)
+        return select_algorithm_list
+
+    def _change_str_to_map(self: any, algorithm_param_info: list, algorithm_args: str) -> dict:
+        param_map = {}
+        for param_str in algorithm_param_info:
+            if param_str.strip():
+                param = param_str.split('=')
+                self._check_value_invalid(param, algorithm_args)
+                self._check_value_invalid(param[0].strip(), algorithm_args)
+                self._check_value_invalid(param[1].strip(), algorithm_args)
+                param_map[param[0].strip()] = param[1].strip()
+        return param_map
+
+    def _parse_algorithm_argument(self: any, algorithm_options: str) -> dict:
+        algorithm_param = {}
+        if not algorithm_options:
+            return algorithm_param
+
+        for algorithm_args in algorithm_options.split(';'):
+            if algorithm_args:
+                algorithm_param_info = algorithm_args.split(':')
+                self._check_value_invalid(algorithm_param_info, algorithm_args)
+                algorithm_name = algorithm_param_info[0].strip()
+                self._check_value_invalid(algorithm_name, algorithm_args)
+                param_map = self._change_str_to_map(algorithm_param_info[1].split(','), algorithm_args)
+                self._update_algorithm_param(algorithm_name, algorithm_param, param_map)
+        return algorithm_param
+
+    def _make_support_algorithm(self: any) -> None:
+        """
+        Make support algorithm list for custom and built in
+        """
+        dir_path = os.path.join(os.path.dirname(__file__), ConstManager.BUILT_IN_ALGORITHM_DIR_NAME)
+        log.print_info_log("dir_path:%s" % dir_path)
+        self._make_support_algorithm_by_path(dir_path, self.built_in_support_algorithm)
+        if self.custom_path:
+            ret = path_check.check_path_valid(
+                self.custom_path, True, False, path_check.PathType.Directory)
+            if ret != CompareError.MSACCUCMP_NONE_ERROR:
+                raise CompareError(ret)
+            dir_path = os.path.join(self.custom_path, ConstManager.CUSTOM_ALGORITHM_DIR_NAME)
+            path_check.check_path_all_file_exec_valid(dir_path)
+            self._make_support_algorithm_by_path(dir_path, self.custom_support_algorithm)
+
+    def _get_module(self: any, algorithm_name: str) -> (bool, any, str):
+        if algorithm_name in self.custom_support_algorithm:
+            sys.path.append(self.custom_path)
+            algorithm_module = importlib.import_module('%s.alg_%s' %
+                                                       (ConstManager.CUSTOM_ALGORITHM_DIR_NAME,
+                                                        algorithm_name))
+            module_type = ConstManager.CUSTOM
+        elif algorithm_name in self.built_in_support_algorithm:
+            algorithm_module = importlib.import_module('%s.%s.alg_%s' %
+                                                       ("msprobe.msaccucmp.algorithm_manager",
+                                                        ConstManager.BUILT_IN_ALGORITHM_DIR_NAME,
+                                                        algorithm_name))
+            module_type = ConstManager.BUILTIN
+        else:
+            return False, '', ''
+        # check exist compare attr
+        if not hasattr(algorithm_module, ConstManager.COMPARE_FUNC_NAME):
+            log.print_warn_log("[%s] The file '%s' has no attribute '%s'. Please check the file."
+                               % (module_type, str(algorithm_module.__file__), ConstManager.COMPARE_FUNC_NAME))
+            return False, algorithm_module, module_type
+        return True, algorithm_module, module_type
+
+    def _make_select_algorithm_map(self: any) -> dict:
+        """
+        Make support algorithm map by select algorithm list
+        """
+        support_algorithm_map = {}
+        for select_algorithm in self.select_algorithm_list:
+            get_ok, algorithm_module, module_type = self._get_module(select_algorithm)
+            if not get_ok:
+                continue
+            get_ok, algorithm_func = self._get_function(algorithm_module, module_type)
+            if not get_ok:
+                continue
+            support_algorithm_map[select_algorithm] = algorithm_func
+        if not support_algorithm_map:
+            log.print_error_log(
+                "The algorithm in %s does not supported. Just supports %s. Please check the "
+                "select algorithm name." % (self.select_algorithm_list,
+                                            self.built_in_support_algorithm + self.custom_support_algorithm))
+            raise CompareError(CompareError.MSACCUCMP_INVALID_ALGORITHM_ERROR)
+        return support_algorithm_map
+
+    def _make_support_algorithm_by_path(self: any, dir_path: str, support_algorithm_list: list) -> None:
+        if not os.path.exists(dir_path):
+            log.print_warn_log("There is no '%s' in '%r', please check the custom path."
+                               % (ConstManager.CUSTOM_ALGORITHM_DIR_NAME, os.path.dirname(dir_path)))
+            return
+        one_match = False
+        for item in os.listdir(dir_path):
+            if self._add_algorithm_file_to_list(os.path.join(dir_path, item), support_algorithm_list):
+                one_match = True
+        if not one_match:
+            log.print_warn_log("There is no legal 'alg_{algorithm_name}.py' file in '%r', "
+                               "please check the path." % dir_path)
+
+    def _make_algorithm_param(self: any, algorithm_name: str, args: dict) -> AlgorithmParameter:
+        alg_arg_map = args
+        if algorithm_name in self.algorithm_param:
+            alg_arg_map = dict(self.algorithm_param.get(algorithm_name), **args)
+        alg_args = AlgorithmParameter()
+        alg_args.__dict__ = alg_arg_map
+        return alg_args
+
+    def _call_compare_function(self: any, *args: any) -> (str, str):
+        compare_func, my_output_dump_data, ground_truth_dump_data, alg_args, algorithm_name = args
+        alg_result = ''
+        alg_error_msg = ''
+        try:
+            if compare_func:
+                alg_result, alg_error_msg = compare_func(my_output_dump_data, ground_truth_dump_data, alg_args)
+                self._check_return_value_valid(alg_result, algorithm_name)
+                self._check_return_value_valid(alg_error_msg, algorithm_name)
+        except Exception as ex:
+            alg_error_msg = "Failed to execute '%s' in '%s'. %s" \
+                            % (ConstManager.COMPARE_FUNC_NAME, algorithm_name, str(ex))
+            log.print_warn_log(alg_error_msg)
+            alg_result = ConstManager.NAN
+        finally:
+            pass
+        return alg_result, alg_error_msg
+
+
+class AlgorithmManagerMain:
+    """
+    The class for algorithm manager main
+    """
+
+    def __init__(self: any, args: any) -> None:
+        self.my_output_dump_file_path = os.path.realpath(args.my_dump_path)
+        self.ground_truth_dump_file_path = os.path.realpath(args.golden_dump_path)
+        self.manager = AlgorithmManager(args.custom_script_path, args.algorithm, args.algorithm_options)
+        if args.output_path:
+            if os.path.islink(os.path.abspath(args.output_path)):
+                log.print_error_log('The path "%r" is a softlink, not permitted.' % args.output_path)
+                raise CompareError(CompareError.MSACCUCMP_INVALID_PATH_ERROR)
+            self.output_path = os.path.realpath(args.output_path)
+
+    def check_arguments_valid(self: any) -> None:
+        """
+        Check arguments valid, if invalid, throw exception
+        """
+        ret = path_check.check_path_valid(self.my_output_dump_file_path, True, False,
+                                          path_check.PathType.File)
+        if ret != CompareError.MSACCUCMP_NONE_ERROR:
+            raise CompareError(ret)
+        ret = path_check.check_path_valid(self.ground_truth_dump_file_path, True, False,
+                                          path_check.PathType.File)
+        if ret != CompareError.MSACCUCMP_NONE_ERROR:
+            raise CompareError(ret)
+
+    def process(self: any, save_result: bool = False) -> int:
+        """
+        Do compare for two numpy file
+        :param save_result: is save result
+        :return: VectorComparisonErrorCode
+        """
+        self.check_arguments_valid()
+        log.print_info_log("The my output dump file is %r." % self.my_output_dump_file_path)
+        log.print_info_log("The ground truth file is %r." % self.ground_truth_dump_file_path)
+        try:
+            self._process_exec(save_result)
+        except CompareError as error:
+            return error.code
+        finally:
+            pass
+        return CompareError.MSACCUCMP_NONE_ERROR
+
+    def _process_exec(self: any, save_result: bool) -> None:
+        my_output_dump_data = dump_utils.read_numpy_file(self.my_output_dump_file_path)
+        ground_truth_dump_data = dump_utils.read_numpy_file(self.ground_truth_dump_file_path)
+        self._check_shape_valid(my_output_dump_data, ground_truth_dump_data)
+
+        result, error_msg = self.manager.compare(
+            my_output_dump_data.flatten(), ground_truth_dump_data.flatten(),
+            {'my_output_dump_file': self.my_output_dump_file_path,
+             'ground_truth_dump_file': self.ground_truth_dump_file_path,
+             'shape_type': utils.get_shape_type(my_output_dump_data.shape)})
+        self._print_result(result, error_msg, save_result)
+
+    def _print_result(self: any, result: list, error_msg: list, save_result: bool) -> None:
+        header = self.manager.get_result_title()
+        title = ''
+        line = ''
+        for (algorithm_index, value) in enumerate(result):
+            while len(line) < len(title):
+                line += ConstManager.SPACE
+            while len(title) < len(line):
+                title += ConstManager.SPACE
+            title += str(header[algorithm_index]) + ConstManager.SPACE
+            line += str(value) + ConstManager.SPACE
+        log.print_info_log(title)
+        log.print_info_log(line)
+        if error_msg:
+            log.print_info_log(str(error_msg))
+        if save_result:
+            content = ""
+            for index, data in enumerate(result):
+                content += "%s: %s\n" % (header[index], data)
+            file_name = 'file_result_%s.txt' % time.strftime("%Y%m%d%H%M%S", time.localtime(time.time()))
+            path_type = path_check.PathType.File
+            summary_file_path = os.path.join(self.output_path, file_name)
+            ret = path_check.check_output_path_valid(summary_file_path, exist=False, path_type=path_type)
+            if ret != CompareError.MSACCUCMP_NONE_ERROR:
+                raise CompareError(ret)
+            FileUtils.save_file(summary_file_path, content)
+            log.print_info_log('The file compare result have been written to "%r".' % summary_file_path)
+
+    def _check_shape_valid(self: any, my_output_dump_data: any, ground_truth_dump_data: any) -> None:
+        my_output_shape = my_output_dump_data.shape
+        ground_truth_shape = ground_truth_dump_data.shape
+        if my_output_shape != ground_truth_shape:
+            log.print_error_log("My output shape %s in '%r' does not match the ground truth shape %s in '%r'."
+                                % (my_output_shape, self.my_output_dump_file_path, ground_truth_shape,
+                                   self.ground_truth_dump_file_path))
+            raise CompareError(CompareError.MSACCUCMP_INVALID_SHAPE_ERROR)

msprobe/msaccucmp/algorithm_manager/algorithm_parameter.py

@@ -0,0 +1,42 @@
+# coding=utf-8
+# -------------------------------------------------------------------------
+#  This file is part of the MindStudio project.
+# Copyright (c) 2025 Huawei Technologies Co.,Ltd.
+#
+# MindStudio is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan PSL v2.
+# You may obtain a copy of Mulan PSL v2 at:
+#
+#          http://license.coscl.org.cn/MulanPSL2
+#
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+# EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+# MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+# -------------------------------------------------------------------------
+
+"""
+Function:
+AlgorithmParameter class.
+"""
+
+
+class AlgorithmParameter:
+    """
+    The class for algorithm parameter
+    """
+
+    def __init__(self: any) -> None:
+        pass
+
+    def get(self: any) -> dict:
+        """
+        get dict
+        """
+        return self.__dict__
+
+    def get_dict(self: any) -> dict:
+        """
+        get dict
+        """
+        return self.__dict__

msprobe/msaccucmp/algorithm_manager/builtin_algorithm/alg_AccumulatedRelativeError.py

@@ -0,0 +1,46 @@
+# coding=utf-8
+# -------------------------------------------------------------------------
+#  This file is part of the MindStudio project.
+# Copyright (c) 2025 Huawei Technologies Co.,Ltd.
+#
+# MindStudio is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan PSL v2.
+# You may obtain a copy of Mulan PSL v2 at:
+#
+#          http://license.coscl.org.cn/MulanPSL2
+#
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+# EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+# MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+# -------------------------------------------------------------------------
+
+"""
+Function:
+AccumulatedRelativeError algorithm. This file mainly involves the compare function.
+"""
+
+import numpy as np
+
+from msprobe.msaccucmp.algorithm_manager.algorithm_parameter import AlgorithmParameter
+from msprobe.msaccucmp.cmp_utils.constant.const_manager import ConstManager
+from msprobe.msaccucmp.cmp_utils import utils
+
+
+def compare(my_output_dump_data: any, ground_truth_dump_data: any, args: AlgorithmParameter) -> (str, str):
+    """
+    compare my output dump data and the ground truth dump data
+    by accumulated relative error
+    formula is (|x[i]-y[i]|) / |y[i]| + (x[i+1]-y[i+1]) / y[i+1]
+    :param my_output_dump_data: my output dump data to compare
+    :param ground_truth_dump_data: the ground truth dump data to compare
+    :param args: the algorithm parameter
+    :return: the result of accumulated relative error value and error message (the default is "")
+    """
+    _ = args  # Bypassing parameter is not used
+    result = np.where(
+        np.abs(ground_truth_dump_data) > ConstManager.FLOAT_EPSILON,
+        np.abs(my_output_dump_data / ground_truth_dump_data - 1),  # abs(aa - bb) / abs(bb) -> abs(aa / bb - 1)
+        0,
+    ).sum()
+    return utils.format_value(result), ""

msprobe/msaccucmp/algorithm_manager/builtin_algorithm/alg_CosineSimilarity.py

@@ -0,0 +1,58 @@
+# coding=utf-8
+# -------------------------------------------------------------------------
+#  This file is part of the MindStudio project.
+# Copyright (c) 2025 Huawei Technologies Co.,Ltd.
+#
+# MindStudio is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan PSL v2.
+# You may obtain a copy of Mulan PSL v2 at:
+#
+#          http://license.coscl.org.cn/MulanPSL2
+#
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+# EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+# MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+# -------------------------------------------------------------------------
+
+"""
+Function:
+CosineSimilarity algorithm. This file mainly involves the compare function.
+"""
+
+import numpy as np
+
+from msprobe.msaccucmp.algorithm_manager.algorithm_parameter import AlgorithmParameter
+from msprobe.msaccucmp.cmp_utils import utils, utils_type, log
+from msprobe.msaccucmp.cmp_utils.constant.const_manager import ConstManager
+
+
+def compare(my_output_dump_data: any, ground_truth_dump_data: any, args: AlgorithmParameter) -> (str, str):
+    """
+    compare my output dump data and the ground truth dump data
+    by cosine similarity
+    cos(sitar) = sum(x[i] * y[i]) /
+    (sqrt(sum(x[i] * x[i])) * sqrt(sum(y[i] * y[i])))
+    :param my_output_dump_data: my output dump data to compare
+    :param ground_truth_dump_data: the ground truth dump data to compare
+    :param args: the algorithm parameter
+    :return: the result of cosine similarity value and error message (the default is "")
+    """
+    if args.shape_type == utils_type.ShapeType.Scalar:
+        return utils.format_value(1), "This tensor is scalar."
+
+    my_output_norm = np.linalg.norm(my_output_dump_data, axis=-1, keepdims=True)
+    ground_truth_norm = np.linalg.norm(ground_truth_dump_data, axis=-1, keepdims=True)
+    if my_output_norm <= ConstManager.FLOAT_EPSILON and ground_truth_norm < ConstManager.FLOAT_EPSILON:
+        return "1.0", ""
+    elif my_output_norm ** 0.5 <= ConstManager.FLOAT_EPSILON:
+        message = 'Cannot compare by Cosine Similarity. All the data is zero in ' + args.my_output_dump_file + '.'
+        log.print_warn_log(message)
+        return ConstManager.NAN, message
+    elif ground_truth_norm ** 0.5 <= ConstManager.FLOAT_EPSILON:
+        message = 'Cannot compare by Cosine Similarity. All the data is zero in ' + args.ground_truth_dump_file + '.'
+        log.print_warn_log(message)
+        return ConstManager.NAN, message
+
+    result = ((my_output_dump_data / my_output_norm) * (ground_truth_dump_data / ground_truth_norm)).sum()
+    return utils.format_value(min(result, 1.0)), ""