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

msprobe/core/common/exceptions.py

@@ -8,13 +8,13 @@ class CodedException(Exception):
         return self.error_info
 
 
-class MsaccException(CodedException):
+class MsprobeException(CodedException):
     INVALID_PARAM_ERROR = 0
     OVERFLOW_NUMS_ERROR = 1
 
     err_strs = {
-        INVALID_PARAM_ERROR: "[msacc] 无效参数： ",
-        OVERFLOW_NUMS_ERROR: "[msacc] 超过预设溢出次数 当前溢出次数:"
+        INVALID_PARAM_ERROR: "[msprobe] 无效参数： ",
+        OVERFLOW_NUMS_ERROR: "[msprobe] 超过预设溢出次数 当前溢出次数:"
     }
 
 
@@ -27,12 +27,12 @@ class FileCheckException(CodedException):
     FILE_TOO_LARGE_ERROR = 5
 
     err_strs = {
-        SOFT_LINK_ERROR: "[msacc] 检测到软链接： ",
-        FILE_PERMISSION_ERROR: "[msacc] 文件权限错误： ",
-        INVALID_FILE_ERROR: "[msacc] 无效文件： ",
-        ILLEGAL_PATH_ERROR: "[msacc] 非法文件路径： ",
-        ILLEGAL_PARAM_ERROR: "[msacc] 非法打开方式： ",
-        FILE_TOO_LARGE_ERROR: "[msacc] 文件过大： "
+        SOFT_LINK_ERROR: "[msprobe] 检测到软链接： ",
+        FILE_PERMISSION_ERROR: "[msprobe] 文件权限错误： ",
+        INVALID_FILE_ERROR: "[msprobe] 无效文件： ",
+        ILLEGAL_PATH_ERROR: "[msprobe] 非法文件路径： ",
+        ILLEGAL_PARAM_ERROR: "[msprobe] 非法打开方式： ",
+        FILE_TOO_LARGE_ERROR: "[msprobe] 文件过大： "
     }
 
 
@@ -40,8 +40,8 @@ class ParseJsonException(CodedException):
     UnexpectedNameStruct = 0
     InvalidDumpJson = 1
     err_strs = {
-        UnexpectedNameStruct: "[msacc] Unexpected name in json: ",
-        InvalidDumpJson: "[msacc] json格式不正确: ",
+        UnexpectedNameStruct: "[msprobe] Unexpected name in json: ",
+        InvalidDumpJson: "[msprobe] json格式不正确: ",
     }
 
 
@@ -50,23 +50,23 @@ class ScopeException(CodedException):
     InvalidScope = 1
     ArgConflict = 2
     err_strs = {
-        InvalidApiStr: "[msacc] Invalid api_list: ",
-        InvalidScope: "[msacc] Invalid scope: ",
-        ArgConflict: "[msacc] Scope and api_list conflict: ",
+        InvalidApiStr: "[msprobe] Invalid api_list: ",
+        InvalidScope: "[msprobe] Invalid scope: ",
+        ArgConflict: "[msprobe] Scope and api_list conflict: ",
     }
 
 
 class RepairException(CodedException):
     InvalidRepairType = 0
     err_strs = {
-        InvalidRepairType: "[msacc] Invalid repair_type: "
+        InvalidRepairType: "[msprobe] Invalid repair_type: "
     }
 
 
 class StepException(CodedException):
     InvalidPostProcess = 0
     err_strs = {
-        InvalidPostProcess: "[msacc] 错误的step后处理配置: ",
+        InvalidPostProcess: "[msprobe] 错误的step后处理配置: ",
     }
 
 
@@ -74,8 +74,8 @@ class FreeBenchmarkException(CodedException):
     UnsupportedType = 0
     InvalidGrad = 1
     err_strs = {
-        UnsupportedType: "[msacc] Free benchmark get unsupported type: ",
-        InvalidGrad: "[msacc] Free benchmark gradient invalid: ",
+        UnsupportedType: "[msprobe] Free benchmark get unsupported type: ",
+        InvalidGrad: "[msprobe] Free benchmark gradient invalid: ",
     }
 
 
@@ -86,3 +86,15 @@ class DistributedNotInitializedError(Exception):
 
     def __str__(self):
         return self.msg
+
+class ApiAccuracyCheckerException(CodedException):
+    ParseJsonFailed = 0
+    UnsupportType = 1
+    WrongValue = 2
+    ApiWrong = 3
+    err_strs = {
+        ParseJsonFailed: "[msprobe] Api Accuracy Checker parse json failed: ",
+        UnsupportType: "[msprobe] Api Accuracy Checker get unsupported type: ",
+        WrongValue: "[msprobe] Api Accuracy Checker get wrong value: ",
+        ApiWrong: "[msprobe] Api Accuracy Checker something wrong with api: ",
+    }

msprobe/core/common/file_check.py

@@ -262,4 +262,22 @@ def change_mode(path, mode):
 
 def path_len_exceeds_limit(file_path):
     return len(os.path.realpath(file_path)) > FileCheckConst.DIRECTORY_LENGTH or \
-        len(os.path.basename(file_path)) > FileCheckConst.FILE_NAME_LENGTH
+        len(os.path.basename(file_path)) > FileCheckConst.FILE_NAME_LENGTH
+
+
+def check_file_type(path):
+    """
+    Function Description:
+        determine if it is a file or a directory
+    Parameter:
+        path: path
+    Exception Description:
+        when neither a file nor a directory throw exception
+    """
+    if os.path.isdir(path):
+        return FileCheckConst.DIR
+    elif os.path.isfile(path):
+        return FileCheckConst.FILE
+    else:
+        logger.error('Neither a file nor a directory.')
+        raise FileCheckException(FileCheckException.INVALID_FILE_ERROR)

msprobe/core/common/log.py

@@ -1,6 +1,9 @@
 import os
 import time
 import sys
+from functools import wraps
+from msprobe.core.common.const import MsgConst
+
 
 class BaseLogger:
     def __init__(self):
@@ -20,12 +23,23 @@ class BaseLogger:
     def get_rank(self):
         return self.rank
 
+    def filter_special_chars(func):
+        @wraps(func)
+        def func_level(self, msg):
+            for char in MsgConst.SPECIAL_CHAR:
+                msg = msg.replace(char, '_')
+            return func(self, msg)
+        return func_level
+
+    @filter_special_chars
     def info(self, msg):
         self._print_log(self.info_level, msg)
 
+    @filter_special_chars
     def error(self, msg):
         self._print_log(self.error_level, msg)
 
+    @filter_special_chars
     def warning(self, msg):
         self._print_log(self.warning_level, msg)
 
@@ -52,4 +66,4 @@ class BaseLogger:
         raise exception
 
 
-logger = BaseLogger()
+logger = BaseLogger()

msprobe/core/common/utils.py

@@ -18,16 +18,17 @@ import collections
 import os
 import re
 import shutil
-import stat
 import subprocess
 import time
 import json
+import csv
 from datetime import datetime, timezone
 from pathlib import Path
+import yaml
 import numpy as np
 
-from msprobe.core.common.file_check import FileOpen, FileChecker
-from msprobe.core.common.const import Const, FileCheckConst, CompareConst, OverflowConst
+from msprobe.core.common.file_check import FileOpen, FileChecker, change_mode
+from msprobe.core.common.const import Const, FileCheckConst, CompareConst
 from msprobe.core.common.log import logger
 
 
@@ -148,21 +149,24 @@ def check_summary_only_valid(summary_only):
     return summary_only
 
 
-def check_compare_param(input_parma, output_path, stack_mode=False, summary_compare=False, md5_compare=False):
-    if not (isinstance(input_parma, dict) and isinstance(output_path, str)):
+def check_compare_param(input_param, output_path, summary_compare=False, md5_compare=False):
+    if not (isinstance(input_param, dict) and isinstance(output_path, str)):
         logger.error("Invalid input parameters")
         raise CompareException(CompareException.INVALID_PARAM_ERROR)
-    check_file_or_directory_path(input_parma.get("npu_json_path"), False)
-    check_file_or_directory_path(input_parma.get("bench_json_path"), False)
-    check_file_or_directory_path(input_parma.get("stack_json_path"), False)
+
+    check_file_or_directory_path(input_param.get("npu_json_path"), False)
+    check_file_or_directory_path(input_param.get("bench_json_path"), False)
+    check_file_or_directory_path(input_param.get("stack_json_path"), False)
     if not summary_compare and not md5_compare:
-        check_file_or_directory_path(input_parma.get("npu_dump_data_dir"), True)
-        check_file_or_directory_path(input_parma.get("bench_dump_data_dir"), True)
+        check_file_or_directory_path(input_param.get("npu_dump_data_dir"), True)
+        check_file_or_directory_path(input_param.get("bench_dump_data_dir"), True)
     check_file_or_directory_path(output_path, True)
-    with FileOpen(input_parma.get("npu_json_path"), "r") as npu_json, \
-         FileOpen(input_parma.get("bench_json_path"), "r") as bench_json, \
-         FileOpen(input_parma.get("stack_json_path"), "r") as stack_json:
-        check_json_file(input_parma, npu_json, bench_json, stack_json)
+
+    with FileOpen(input_param.get("npu_json_path"), "r") as npu_json, \
+            FileOpen(input_param.get("bench_json_path"), "r") as bench_json, \
+            FileOpen(input_param.get("stack_json_path"), "r") as stack_json:
+        check_json_file(input_param, npu_json, bench_json, stack_json)
+
 
 
 def check_configuration_param(stack_mode=False, auto_analyze=True, fuzzy_match=False):
@@ -257,6 +261,17 @@ def remove_path(path):
         raise CompareException(CompareException.INVALID_PATH_ERROR) from err
 
 
+def move_file(src_path, dst_path):
+    check_file_or_directory_path(src_path)
+    check_path_before_create(dst_path)
+    try:
+        shutil.move(src_path, dst_path)
+    except Exception as e:
+        logger.error(f"move file {src_path} to {dst_path} failed")
+        raise RuntimeError(f"move file {src_path} to {dst_path} failed") from e
+    change_mode(dst_path, FileCheckConst.DATA_FILE_AUTHORITY)
+
+
 def get_dump_data_path(dump_dir):
     """
     Function Description:
@@ -289,6 +304,7 @@ def create_directory(dir_path):
         when invalid data throw exception
     """
     if not os.path.exists(dir_path):
+        check_path_before_create(dir_path)
         try:
             os.makedirs(dir_path, mode=0o700)
         except OSError as ex:
@@ -318,15 +334,6 @@ def execute_command(cmd):
         raise CompareException(CompareException.INVALID_DATA_ERROR)
 
 
-def save_numpy_data(file_path, data):
-    """
-    save_numpy_data
-    """
-    if not os.path.exists(os.path.dirname(file_path)):
-        os.makedirs(os.path.dirname(file_path))
-    np.save(file_path, data)
-
-
 def parse_value_by_comma(value):
     """
     parse value by comma, like '1,2,4,8'
@@ -472,14 +479,14 @@ def md5_find(data):
 
 
 def task_dumppath_get(input_param):
-    npu_json_path = input_param.get("npu_json_path", None)
-    bench_json_path = input_param.get("bench_json_path", None)
-    if not npu_json_path or not bench_json_path:
+    npu_path = input_param.get("npu_json_path", None)
+    bench_path = input_param.get("bench_json_path", None)
+    if not npu_path or not bench_path:
         logger.error(f"Please check the json path is valid.")
         raise CompareException(CompareException.INVALID_PATH_ERROR)
-    with FileOpen(npu_json_path, 'r') as npu_f:
+    with FileOpen(npu_path, 'r') as npu_f:
         npu_json_data = json.load(npu_f)
-    with FileOpen(bench_json_path, 'r') as bench_f:
+    with FileOpen(bench_path, 'r') as bench_f:
         bench_json_data = json.load(bench_f)
     if npu_json_data['task'] != bench_json_data['task']:
         logger.error(f"Please check the dump task is consistent.")
@@ -496,8 +503,8 @@ def task_dumppath_get(input_param):
     else:
         logger.error(f"Compare is not required for overflow_check or free_benchmark.")
         raise CompareException(CompareException.INVALID_TASK_ERROR)
-    input_param['npu_dump_data_dir'] = npu_json_data['dump_data_dir']
-    input_param['bench_dump_data_dir'] = bench_json_data['dump_data_dir']
+    input_param['npu_dump_data_dir'] = os.path.join(os.path.dirname(npu_path), Const.DUMP_TENSOR_DATA)
+    input_param['bench_dump_data_dir'] = os.path.join(os.path.dirname(bench_path), Const.DUMP_TENSOR_DATA)
     return summary_compare, md5_compare
 
 
@@ -514,3 +521,96 @@ def get_header_index(header_name, summary_compare=False):
 
 def convert_tuple(data):
     return data if isinstance(data, tuple) else (data, )
+
+
+def write_csv(data, filepath, mode="a+"):
+    exist = os.path.exists(filepath)
+    with FileOpen(filepath, mode, encoding='utf-8-sig') as f:
+        writer = csv.writer(f)
+        writer.writerows(data)
+    if not exist:
+        change_mode(filepath, FileCheckConst.DATA_FILE_AUTHORITY)
+
+
+def load_npy(filepath):
+    check_file_or_directory_path(filepath)
+    try:
+        npy = np.load(filepath)
+    except Exception as e:
+        logger.error(f"The numpy file failed to load. Please check the path: {filepath}.")
+        raise RuntimeError(f"Load numpy file {filepath} failed.") from e
+    return npy
+
+
+def save_npy(data, filepath):
+    filepath = os.path.realpath(filepath)
+    check_path_before_create(filepath)
+    try:
+        np.save(filepath, data)
+    except Exception as e:
+        logger.error(f"The numpy file failed to save. Please check the path: {filepath}.")
+        raise RuntimeError(f"Save numpy file {filepath} failed.") from e
+    change_mode(filepath, FileCheckConst.DATA_FILE_AUTHORITY)
+
+def save_npy_to_txt(self, data, dst_file='', align=0):
+    if os.path.exists(dst_file):
+        self.log.info("Dst file %s exists, will not save new one.", dst_file)
+        return
+    shape = data.shape
+    data = data.flatten()
+    if align == 0:
+        align = 1 if len(shape) == 0 else shape[-1]
+    elif data.size % align != 0:
+        pad_array = np.zeros((align - data.size % align,))
+        data = np.append(data, pad_array)
+    check_path_before_create(dst_file)
+    try:
+        np.savetxt(dst_file, data.reshape((-1, align)), delimiter=' ', fmt='%g')
+    except Exception as e:
+        self.log.error("An unexpected error occurred: %s when savetxt to %s" % (str(e)), dst_file)
+    change_mode(dst_file, FileCheckConst.DATA_FILE_AUTHORITY)
+
+def get_json_contents(file_path):
+    ops = get_file_content_bytes(file_path)
+    try:
+        json_obj = json.loads(ops)
+    except ValueError as error:
+        logger.error('Failed to load json.')
+        raise CompareException(CompareException.INVALID_FILE_ERROR) from error
+    if not isinstance(json_obj, dict):
+        logger.error('Json file content is not a dictionary!')
+        raise CompareException(CompareException.INVALID_FILE_ERROR)
+    return json_obj
+
+
+def get_file_content_bytes(file):
+    with FileOpen(file, 'rb') as file_handle:
+        return file_handle.read()
+
+
+def load_yaml(yaml_path):
+    path_checker = FileChecker(yaml_path, FileCheckConst.FILE, FileCheckConst.READ_ABLE, FileCheckConst.YAML_SUFFIX)
+    checked_path = path_checker.common_check()
+    try:
+        with FileOpen(checked_path, "r") as f:
+            yaml_data = yaml.safe_load(f)
+    except Exception as e:
+        logger.error(f"The yaml file failed to load. Please check the path: {checked_path}.")
+        raise RuntimeError(f"Load yaml file {checked_path} failed.") from e
+    return yaml_data
+
+
+def save_workbook(workbook, file_path):
+    """
+    保存工作簿到指定的文件路径
+    workbook: 要保存的工作簿对象
+    file_path: 文件保存路径
+    """
+    file_path = os.path.realpath(file_path)
+    check_path_before_create(file_path)
+    try:
+        workbook.save(file_path)
+    except Exception as e:
+        logger.error(f'Save result file "{os.path.basename(file_path)}" failed')
+        raise CompareException(CompareException.WRITE_FILE_ERROR) from e
+    change_mode(file_path, FileCheckConst.DATA_FILE_AUTHORITY)

msprobe/core/common_config.py

@@ -1,6 +1,6 @@
 from msprobe.core.common.const import Const
 from msprobe.core.common.log import logger
-from msprobe.core.common.exceptions import MsaccException
+from msprobe.core.common.exceptions import MsprobeException
 
 
 class CommonConfig:
@@ -18,24 +18,27 @@ class CommonConfig:
 
     def _check_config(self):
         if self.task and self.task not in Const.TASK_LIST:
-            logger.error_log_with_exp(
-                "task is invalid, it should be one of {}".format(Const.TASK_LIST), MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("task is invalid, it should be one of {}".format(Const.TASK_LIST),
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if self.rank is not None and not isinstance(self.rank, list):
-            logger.error_log_with_exp("rank is invalid, it should be a list", MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("rank is invalid, it should be a list",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if self.step is not None and not isinstance(self.step, list):
-            logger.error_log_with_exp("step is invalid, it should be a list", MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("step is invalid, it should be a list",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if self.level and self.level not in Const.LEVEL_LIST:
-            logger.error_log_with_exp(
-                "level is invalid, it should be one of {}".format(Const.LEVEL_LIST), MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("level is invalid, it should be one of {}".format(Const.LEVEL_LIST),
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if self.seed is not None and not isinstance(self.seed, int):
-            logger.error_log_with_exp("seed is invalid, it should be an integer", MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("seed is invalid, it should be an integer",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if not isinstance(self.is_deterministic, bool):
-            logger.error_log_with_exp(
-                "is_deterministic is invalid, it should be a boolean", MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("is_deterministic is invalid, it should be a boolean",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if not isinstance(self.enable_dataloader, bool):
-            logger.error_log_with_exp(
-                "enable_dataloader is invalid, it should be a boolean", MsaccException(MsaccException.INVALID_PARAM_ERROR))
-        
+            logger.error_log_with_exp("enable_dataloader is invalid, it should be a boolean",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
+
 
 class BaseConfig:
     def __init__(self, json_config):
@@ -44,15 +47,25 @@ class BaseConfig:
         self.data_mode = json_config.get('data_mode')
         self.backward_input = json_config.get("backward_input")
         self.file_format = json_config.get("file_format")
-        self.summary_mode =  json_config.get("summary_mode")
-        self.overflow_num = json_config.get("overflow_num")
+        self.summary_mode = json_config.get("summary_mode")
+        self.overflow_nums = json_config.get("overflow_nums")
         self.check_mode = json_config.get("check_mode")
+        self.fuzz_device = json_config.get("fuzz_device")
+        self.pert_mode = json_config.get("pert_mode")
+        self.handler_type = json_config.get("handler_type")
+        self.fuzz_level = json_config.get("fuzz_level")
+        self.fuzz_stage = json_config.get("fuzz_stage")
+        self.if_preheat = json_config.get("if_preheat")
+        self.preheat_step = json_config.get("preheat_step")
+        self.max_sample = json_config.get("max_sample")
 
     def check_config(self):
         if self.scope is not None and not isinstance(self.scope, list):
-            logger.error_log_with_exp("scope is invalid, it should be a list", MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("scope is invalid, it should be a list",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if self.list is not None and not isinstance(self.list, list):
-            logger.error_log_with_exp("list is invalid, it should be a list", MsaccException(MsaccException.INVALID_PARAM_ERROR))
+            logger.error_log_with_exp("list is invalid, it should be a list",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
         if self.data_mode is not None and not isinstance(self.data_mode, list):
-            logger.error_log_with_exp("data_mode is invalid, it should be a list", MsaccException(MsaccException.INVALID_PARAM_ERROR))
-        
+            logger.error_log_with_exp("data_mode is invalid, it should be a list",
+                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))