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

msprobe/core/common_config.py

@@ -1,19 +1,31 @@
+# Copyright (c) 2024-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.
+
 from msprobe.core.common.const import Const, FileCheckConst
 from msprobe.core.common.log import logger
 from msprobe.core.common.exceptions import MsprobeException
-from msprobe.core.common.file_utils import FileChecker
+from msprobe.core.common.utils import get_real_step_or_rank
 
 
 class CommonConfig:
     def __init__(self, json_config):
         self.task = json_config.get('task')
         self.dump_path = json_config.get('dump_path')
-        self.rank = json_config.get('rank')
-        self.step = json_config.get('step')
+        self.rank = get_real_step_or_rank(json_config.get('rank'), Const.RANK)
+        self.step = get_real_step_or_rank(json_config.get('step'), Const.STEP)
         self.level = json_config.get('level')
-        self.seed = json_config.get('seed')
-        self.acl_config = json_config.get('acl_config')
-        self.is_deterministic = json_config.get('is_deterministic', False)
         self.enable_dataloader = json_config.get('enable_dataloader', False)
         self._check_config()
 
@@ -24,34 +36,12 @@ class CommonConfig:
         if self.dump_path is not None and not isinstance(self.dump_path, str):
             logger.error_log_with_exp("dump_path is invalid, it should be a string",
                                       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",
-                                      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",
-                                      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),
                                       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",
-                                      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",
-                                      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",
                                       MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
-        if self.acl_config:
-            self._check_acl_config()
-
-    def _check_acl_config(self):
-        if not isinstance(self.acl_config, str):
-            logger.error_log_with_exp("acl_config is invalid, it should be a string",
-                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
-        file_checker = FileChecker(
-            file_path=self.acl_config, path_type=FileCheckConst.FILE, file_type=FileCheckConst.JSON_SUFFIX)
-        file_checker.common_check()
 
 
 class BaseConfig:
@@ -59,7 +49,6 @@ class BaseConfig:
         self.scope = json_config.get('scope')
         self.list = json_config.get('list')
         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_nums = json_config.get("overflow_nums")
@@ -73,13 +62,46 @@ class BaseConfig:
         self.preheat_step = json_config.get("preheat_step")
         self.max_sample = json_config.get("max_sample")
 
+    @staticmethod
+    def _check_str_list_config(config_item, config_name):
+        if config_item is not None:
+            if not isinstance(config_item, list):
+                logger.error_log_with_exp(f"{config_name} is invalid, it should be a list[str]",
+                                          MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
+            for name in config_item:
+                if not isinstance(name, str):
+                    logger.error_log_with_exp(f"{config_name} is invalid, it should be a list[str]",
+                                              MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
+
     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",
-                                      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",
-                                      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",
-                                      MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
+        self._check_str_list_config(self.scope, "scope")
+        self._check_str_list_config(self.list, "list")
+        self._check_data_mode()
+
+    def _check_data_mode(self):
+        if self.data_mode is not None:
+            if not isinstance(self.data_mode, list):
+                logger.error_log_with_exp("data_mode is invalid, it should be a list[str]",
+                                          MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
+
+            if Const.ALL in self.data_mode and len(self.data_mode) != 1:
+                logger.error_log_with_exp(
+                    "'all' cannot be combined with other options in data_mode.",
+                    MsprobeException(MsprobeException.INVALID_PARAM_ERROR)
+                )
+
+            if len(self.data_mode) >= len(Const.DUMP_DATA_MODE_LIST):
+                logger.error_log_with_exp(
+                    f"The number of elements in the data_made cannot exceed {len(Const.DUMP_DATA_MODE_LIST) - 1}.",
+                    MsprobeException(MsprobeException.INVALID_PARAM_ERROR)
+                )
+
+            for mode in self.data_mode:
+                if not isinstance(mode, str):
+                    logger.error_log_with_exp("data_mode is invalid, it should be a list[str]",
+                                              MsprobeException(MsprobeException.INVALID_PARAM_ERROR))
+                if mode not in Const.DUMP_DATA_MODE_LIST:
+                    logger.error_log_with_exp(
+                        f"The element '{mode}' of data_mode {self.data_mode} is not in {Const.DUMP_DATA_MODE_LIST}.",
+                        MsprobeException(MsprobeException.INVALID_PARAM_ERROR)
+                    )