|
| 1 | +# Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, |
| 10 | +# software distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | + |
| 16 | +import importlib |
| 17 | +import logging |
| 18 | +from enum import Enum |
| 19 | +from typing import Any, Optional |
| 20 | +from packaging import version |
| 21 | + |
| 22 | +import pkg_resources |
| 23 | + |
| 24 | + |
| 25 | +__all__ = [ |
| 26 | + "Framework", |
| 27 | + "detect_framework", |
| 28 | + "execute_in_sparseml_framework", |
| 29 | + "get_version", |
| 30 | + "check_version", |
| 31 | +] |
| 32 | + |
| 33 | + |
| 34 | +_LOGGER = logging.getLogger(__name__) |
| 35 | + |
| 36 | + |
| 37 | +class Framework(Enum): |
| 38 | + """ |
| 39 | + Framework types known of/supported within the sparseml/deepsparse ecosystem |
| 40 | + """ |
| 41 | + |
| 42 | + unknown = "unknown" |
| 43 | + deepsparse = "deepsparse" |
| 44 | + onnx = "onnx" |
| 45 | + keras = "keras" |
| 46 | + pytorch = "pytorch" |
| 47 | + tensorflow_v1 = "tensorflow_v1" |
| 48 | + |
| 49 | + |
| 50 | +def detect_framework(item: Any) -> Framework: |
| 51 | + """ |
| 52 | + Detect the supported ML framework for a given item. |
| 53 | + Supported input types are the following: |
| 54 | + - A Framework enum |
| 55 | + - A string of any case representing the name of the framework |
| 56 | + (deepsparse, onnx, keras, pytorch, tensorflow_v1) |
| 57 | + - A supported file type within the framework such as model files: |
| 58 | + (onnx, pth, h5, pb) |
| 59 | + - An object from a supported ML framework such as a model instance |
| 60 | + If the framework cannot be determined, will return Framework.unknown |
| 61 | + :param item: The item to detect the ML framework for |
| 62 | + :type item: Any |
| 63 | + :return: The detected framework from the given item |
| 64 | + :rtype: Framework |
| 65 | + """ |
| 66 | + _LOGGER.debug("detecting framework for %s", item) |
| 67 | + framework = Framework.unknown |
| 68 | + |
| 69 | + if isinstance(item, Framework): |
| 70 | + _LOGGER.debug("framework detected from Framework instance") |
| 71 | + framework = item |
| 72 | + elif isinstance(item, str) and item.lower().strip() in Framework.__members__: |
| 73 | + _LOGGER.debug("framework detected from Framework string instance") |
| 74 | + framework = Framework[item.lower().strip()] |
| 75 | + else: |
| 76 | + _LOGGER.debug("detecting framework by calling into supported frameworks") |
| 77 | + |
| 78 | + for test in Framework: |
| 79 | + try: |
| 80 | + framework = execute_in_sparseml_framework( |
| 81 | + test, "detect_framework", item |
| 82 | + ) |
| 83 | + except Exception as err: |
| 84 | + # errors are expected if the framework is not installed, log as debug |
| 85 | + _LOGGER.debug(f"error while calling detect_framework for {test}: {err}") |
| 86 | + |
| 87 | + if framework != Framework.unknown: |
| 88 | + break |
| 89 | + |
| 90 | + _LOGGER.info("detected framework of %s from %s", framework, item) |
| 91 | + |
| 92 | + return framework |
| 93 | + |
| 94 | + |
| 95 | +def execute_in_sparseml_framework( |
| 96 | + framework: Framework, function_name: str, *args, **kwargs |
| 97 | +) -> Any: |
| 98 | + """ |
| 99 | + Execute a general function that is callable from the root of the frameworks |
| 100 | + package under SparseML such as sparseml.pytorch. |
| 101 | + Useful for benchmarking, analyzing, etc. |
| 102 | + Will pass the args and kwargs to the callable function. |
| 103 | + :param framework: The ML framework to run the function under in SparseML. |
| 104 | + :type framework: Framework |
| 105 | + :param function_name: The name of the function in SparseML that should be run |
| 106 | + with the given args and kwargs. |
| 107 | + :type function_name: str |
| 108 | + :param args: Any positional args to be passed into the function. |
| 109 | + :param kwargs: Any key word args to be passed into the function. |
| 110 | + :return: The return value from the executed function. |
| 111 | + :rtype: Any |
| 112 | + """ |
| 113 | + _LOGGER.debug( |
| 114 | + "executing function with name %s for framework %s, args %s, kwargs %s", |
| 115 | + function_name, |
| 116 | + framework, |
| 117 | + args, |
| 118 | + kwargs, |
| 119 | + ) |
| 120 | + |
| 121 | + if not isinstance(framework, Framework): |
| 122 | + framework = detect_framework(framework) |
| 123 | + |
| 124 | + if framework == Framework.unknown: |
| 125 | + raise ValueError( |
| 126 | + f"unknown or unsupported framework {framework}, " |
| 127 | + f"cannot call function {function_name}" |
| 128 | + ) |
| 129 | + |
| 130 | + try: |
| 131 | + module = importlib.import_module(f"sparseml.{framework.value}") |
| 132 | + function = getattr(module, function_name) |
| 133 | + except Exception as err: |
| 134 | + raise ValueError( |
| 135 | + f"could not find function_name {function_name} in framework {framework}: " |
| 136 | + f"{err}" |
| 137 | + ) |
| 138 | + |
| 139 | + return function(*args, **kwargs) |
| 140 | + |
| 141 | + |
| 142 | +def get_version(package_name: str, raise_on_error: bool) -> Optional[str]: |
| 143 | + """ |
| 144 | + :param package_name: The name of the full package, as it would be imported, |
| 145 | + to get the version for |
| 146 | + :type package_name: str |
| 147 | + :param raise_on_error: True to raise an error if package is not installed |
| 148 | + or couldn't be imported, False to return None |
| 149 | + :return: the version of the desired package if detected, otherwise raises an error |
| 150 | + :rtype: str |
| 151 | + """ |
| 152 | + |
| 153 | + try: |
| 154 | + current_version: str = pkg_resources.get_distribution(package_name).version |
| 155 | + except Exception as err: |
| 156 | + if raise_on_error: |
| 157 | + raise ImportError( |
| 158 | + f"error while getting current version for {package_name}: {err}" |
| 159 | + ) |
| 160 | + |
| 161 | + return None |
| 162 | + |
| 163 | + return current_version |
| 164 | + |
| 165 | + |
| 166 | +def check_version( |
| 167 | + package_name: str, |
| 168 | + min_version: Optional[str] = None, |
| 169 | + max_version: Optional[str] = None, |
| 170 | + raise_on_error: bool = True, |
| 171 | +) -> bool: |
| 172 | + """ |
| 173 | + :param package_name: the name of the package to check the version of |
| 174 | + :type package_name: str |
| 175 | + :param min_version: The minimum version for the package that it must be greater than |
| 176 | + or equal to, if unset will require no minimum version |
| 177 | + :type min_version: str |
| 178 | + :param max_version: The maximum version for the package that it must be less than |
| 179 | + or equal to, if unset will require no maximum version. |
| 180 | + :type max_version: str |
| 181 | + :param raise_on_error: True to raise any issues such as not installed, |
| 182 | + minimum version, or maximum version as ImportError. False to return the result. |
| 183 | + :type raise_on_error: bool |
| 184 | + :return: If raise_on_error, will return False if the package is not installed |
| 185 | + or the version is outside the accepted bounds and True if everything is correct. |
| 186 | + :rtype: bool |
| 187 | + """ |
| 188 | + current_version = get_version(package_name, raise_on_error) |
| 189 | + |
| 190 | + if not current_version: |
| 191 | + return False |
| 192 | + |
| 193 | + current_version = version.parse(current_version) |
| 194 | + min_version = version.parse(min_version) if min_version else None |
| 195 | + max_version = version.parse(max_version) if max_version else None |
| 196 | + |
| 197 | + if min_version and current_version < min_version: |
| 198 | + if raise_on_error: |
| 199 | + raise ImportError( |
| 200 | + f"required min {package_name} version {min_version}, " |
| 201 | + f"found {current_version}" |
| 202 | + ) |
| 203 | + return False |
| 204 | + |
| 205 | + if max_version and current_version > max_version: |
| 206 | + if raise_on_error: |
| 207 | + raise ImportError( |
| 208 | + f"required min {package_name} version {min_version}, " |
| 209 | + f"found {current_version}" |
| 210 | + ) |
| 211 | + return False |
| 212 | + |
| 213 | + return True |
0 commit comments