Add default workspace for 3.x (#1553)

Signed-off-by: Kaihui-intel <[email protected]>

---------

Signed-off-by: Kaihui-intel <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: Kaihui-intel

neural_compressor/common/__init__.py

@@ -12,4 +12,41 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from neural_compressor.common.logger import level, log, info, debug, warn, warning, error, fatal
+from neural_compressor.common.utils import (
+    level,
+    log,
+    info,
+    DEBUG,
+    debug,
+    warn,
+    warning,
+    error,
+    fatal,
+    set_random_seed,
+    set_workspace,
+    set_resume_from,
+    set_tensorboard,
+    Logger,
+    logger,
+)
+from neural_compressor.common.base_config import options
+
+
+__all__ = [
+    "level",
+    "log",
+    "info",
+    "DEBUG",
+    "debug",
+    "warn",
+    "warning",
+    "error",
+    "fatal",
+    "options",
+    "Logger",
+    "logger",
+    "set_workspace",
+    "set_random_seed",
+    "set_resume_from",
+    "set_tensorboard",
+]

neural_compressor/common/base_config.py

@@ -25,11 +25,12 @@
 from itertools import product
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
 
-from neural_compressor.common.logger import Logger
-from neural_compressor.common.utility import (
+from neural_compressor.common import Logger
+from neural_compressor.common.utils import (
     BASE_CONFIG,
     COMPOSABLE_CONFIG,
     DEFAULT_WHITE_LIST,
+    DEFAULT_WORKSPACE,
     EMPTY_WHITE_LIST,
     GLOBAL,
     LOCAL,
@@ -38,6 +39,14 @@
 
 logger = Logger().get_logger()
 
+__all__ = [
+    "ConfigRegistry",
+    "register_config",
+    "BaseConfig",
+    "ComposableConfig",
+    "Options",
+    "options",
+]
 
 # Dictionary to store registered configurations
 
@@ -411,3 +420,122 @@ def to_config_mapping(
     def register_supported_configs(cls):
         """Add all supported configs."""
         raise NotImplementedError
+
+
+def _check_value(name, src, supported_type, supported_value=[]):
+    """Check if the given object is the given supported type and in the given supported value.
+
+    Example::
+
+        from neural_compressor.common.base_config import _check_value
+
+        def datatype(self, datatype):
+            if _check_value("datatype", datatype, list, ["fp32", "bf16", "uint8", "int8"]):
+                self._datatype = datatype
+    """
+    if isinstance(src, list) and any([not isinstance(i, supported_type) for i in src]):
+        assert False, "Type of {} items should be {} but not {}".format(
+            name, str(supported_type), [type(i) for i in src]
+        )
+    elif not isinstance(src, list) and not isinstance(src, supported_type):
+        assert False, "Type of {} should be {} but not {}".format(name, str(supported_type), type(src))
+
+    if len(supported_value) > 0:
+        if isinstance(src, str) and src not in supported_value:
+            assert False, "{} is not in supported {}: {}. Skip setting it.".format(src, name, str(supported_value))
+        elif (
+            isinstance(src, list)
+            and all([isinstance(i, str) for i in src])
+            and any([i not in supported_value for i in src])
+        ):
+            assert False, "{} is not in supported {}: {}. Skip setting it.".format(src, name, str(supported_value))
+
+    return True
+
+
+class Options:
+    """Option Class for configs.
+
+    This class is used for configuring global variables. The global variable options is created with this class.
+    If you want to change global variables, you should use functions from neural_compressor.common.utils.utility.py:
+        set_random_seed(seed: int)
+        set_workspace(workspace: str)
+        set_resume_from(resume_from: str)
+        set_tensorboard(tensorboard: bool)
+
+    Args:
+        random_seed(int): Random seed used in neural compressor.
+                          Default value is 1978.
+        workspace(str): The directory where intermediate files and tuning history file are stored.
+                        Default value is:
+                            "./nc_workspace/{}/".format(datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S")).
+        resume_from(str): The directory you want to resume tuning history file from.
+                          The tuning history was automatically saved in the workspace directory
+                               during the last tune process.
+                          Default value is None.
+        tensorboard(bool): This flag indicates whether to save the weights of the model and the inputs of each layer
+                               for visual display.
+                           Default value is False.
+
+    Example::
+
+        from neural_compressor.common import set_random_seed, set_workspace, set_resume_from, set_tensorboard
+        set_random_seed(2022)
+        set_workspace("workspace_path")
+        set_resume_from("workspace_path")
+        set_tensorboard(True)
+    """
+
+    def __init__(self, random_seed=1978, workspace=DEFAULT_WORKSPACE, resume_from=None, tensorboard=False):
+        """Init an Option object."""
+        self.random_seed = random_seed
+        self.workspace = workspace
+        self.resume_from = resume_from
+        self.tensorboard = tensorboard
+
+    @property
+    def random_seed(self):
+        """Get random seed."""
+        return self._random_seed
+
+    @random_seed.setter
+    def random_seed(self, random_seed):
+        """Set random seed."""
+        if _check_value("random_seed", random_seed, int):
+            self._random_seed = random_seed
+
+    @property
+    def workspace(self):
+        """Get workspace."""
+        return self._workspace
+
+    @workspace.setter
+    def workspace(self, workspace):
+        """Set workspace."""
+        if _check_value("workspace", workspace, str):
+            self._workspace = workspace
+
+    @property
+    def resume_from(self):
+        """Get resume_from."""
+        return self._resume_from
+
+    @resume_from.setter
+    def resume_from(self, resume_from):
+        """Set resume_from."""
+        if resume_from is None or _check_value("resume_from", resume_from, str):
+            self._resume_from = resume_from
+
+    @property
+    def tensorboard(self):
+        """Get tensorboard."""
+        return self._tensorboard
+
+    @tensorboard.setter
+    def tensorboard(self, tensorboard):
+        """Set tensorboard."""
+        if _check_value("tensorboard", tensorboard, bool):
+            self._tensorboard = tensorboard
+
+
+options = Options()

neural_compressor/common/base_tuning.py

@@ -18,8 +18,8 @@
 import uuid
 from typing import Any, Callable, Dict, Generator, List, Optional, Tuple, Union
 
+from neural_compressor.common import Logger
 from neural_compressor.common.base_config import BaseConfig, ComposableConfig
-from neural_compressor.common.logger import Logger
 
 logger = Logger().get_logger()
 

neural_compressor/common/utils/__init__.py

@@ -0,0 +1,17 @@
+# Copyright (c) 2023 Intel Corporation
+#
+# 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 neural_compressor.common.utils.constants import *
+from neural_compressor.common.utils.utility import *
+from neural_compressor.common.utils.logger import *

neural_compressor/common/utility.py renamed to neural_compressor/common/utils/constants.py

@@ -32,6 +32,10 @@
 GPTQ = "gptq"
 FP8_QUANT = "fp8_quant"
 
+# options
+import datetime
+
+DEFAULT_WORKSPACE = "./nc_workspace/{}/".format(datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S"))
 
 from typing import Callable, Union
 

neural_compressor/common/logger.py renamed to neural_compressor/common/utils/logger.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2023 Intel Corporation
+#
+# 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.
+
+__all__ = [
+    "set_workspace",
+    "set_random_seed",
+    "set_resume_from",
+    "set_tensorboard",
+]
+
+
+def set_random_seed(seed: int):
+    """Set the random seed in config."""
+    from neural_compressor.common import options
+
+    options.random_seed = seed
+
+
+def set_workspace(workspace: str):
+    """Set the workspace in config."""
+    from neural_compressor.common import options
+
+    options.workspace = workspace
+
+
+def set_resume_from(resume_from: str):
+    """Set the resume_from in config."""
+    from neural_compressor.common import options
+
+    options.resume_from = resume_from
+
+
+def set_tensorboard(tensorboard: bool):
+    """Set the tensorboard in config."""
+    from neural_compressor.common import options
+
+    options.tensorboard = tensorboard

neural_compressor/common/utils/utility.py

@@ -26,7 +26,7 @@
 import tensorflow as tf
 import yaml
 
-from neural_compressor.common.logger import Logger
+from neural_compressor.common import Logger
 from neural_compressor.tensorflow.utils import deep_get, dump_elapsed_time
 
 logger = Logger().get_logger()

neural_compressor/tensorflow/algorithms/static_quantize/keras.py

@@ -17,7 +17,7 @@
 
 import tensorflow as tf
 
-from neural_compressor.common.utility import STATIC_QUANT
+from neural_compressor.common.utils import STATIC_QUANT
 from neural_compressor.tensorflow.algorithms.static_quantize.keras import KerasAdaptor
 from neural_compressor.tensorflow.quantization.config import StaticQuantConfig
 from neural_compressor.tensorflow.utils import register_algo

neural_compressor/tensorflow/algorithms/static_quantize/quantize_entry.py

@@ -23,7 +23,7 @@
 import tensorflow as tf
 
 from neural_compressor.common.base_config import BaseConfig, config_registry, register_config
-from neural_compressor.common.utility import DEFAULT_WHITE_LIST, OP_NAME_OR_MODULE_TYPE, STATIC_QUANT
+from neural_compressor.common.utils import DEFAULT_WHITE_LIST, OP_NAME_OR_MODULE_TYPE, STATIC_QUANT
 
 FRAMEWORK_NAME = "keras"