File size: 12,910 Bytes
b386992 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 |
# Copyright (c) 2025, NVIDIA CORPORATION. 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.
# This file is taken from https://github.com/NVIDIA/NeMo-Curator, which is adapted from cuML's safe_imports module:
# https://github.com/rapidsai/cuml/blob/e93166ea0dddfa8ef2f68c6335012af4420bc8ac/python/cuml/internals/safe_imports.py
import importlib
import logging
import traceback
from contextlib import contextmanager
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
logger.addHandler(logging.StreamHandler())
GPU_INSTALL_STRING = (
"""Install GPU packages via `pip install --extra-index-url """
"""https://pypi.nvidia.com nemo-curator[cuda12x]`
or use `pip install --extra-index-url https://pypi.nvidia.com ".[cuda12x]"` if installing from source"""
)
class UnavailableError(Exception):
"""Error thrown if a symbol is unavailable due to an issue importing it"""
@contextmanager
def null_decorator(*args, **kwargs):
"""null_decorator"""
if len(kwargs) == 0 and len(args) == 1 and callable(args[0]):
return args[0]
else:
def inner(func):
return func
return inner
class UnavailableMeta(type):
"""A metaclass for generating placeholder objects for unavailable symbols
This metaclass allows errors to be deferred from import time to the time
that a symbol is actually used in order to streamline the usage of optional
dependencies. This is particularly useful for attempted imports of GPU-only
modules which will only be invoked if GPU-only functionality is
specifically used.
If an attempt to import a symbol fails, this metaclass is used to generate
a class which stands in for that symbol. Any attempt to call the symbol
(instantiate the class) or access its attributes will throw an
UnavailableError exception. Furthermore, this class can be used in
e.g. isinstance checks, since it will (correctly) fail to match any
instance it is compared against.
In addition to calls and attribute access, a number of dunder methods are
implemented so that other common usages of imported symbols (e.g.
arithmetic) throw an UnavailableError, but this is not guaranteed for
all possible uses. In such cases, other exception types (typically
TypeErrors) will be thrown instead.
"""
def __new__(meta, name, bases, dct):
if dct.get("_msg", None) is None:
dct["_msg"] = f"{name} could not be imported"
name = f"MISSING{name}"
return super(UnavailableMeta, meta).__new__(meta, name, bases, dct)
def __call__(cls, *args, **kwargs):
raise UnavailableError(cls._msg)
def __getattr__(cls, name):
raise UnavailableError(cls._msg)
def __eq__(cls, other):
raise UnavailableError(cls._msg)
def __lt__(cls, other):
raise UnavailableError(cls._msg)
def __gt__(cls, other):
raise UnavailableError(cls._msg)
def __le__(cls, other):
raise UnavailableError(cls._msg)
def __ge__(cls, other):
raise UnavailableError(cls._msg)
def __ne__(cls, other):
raise UnavailableError(cls._msg)
def __abs__(cls):
raise UnavailableError(cls._msg)
def __add__(cls, other):
raise UnavailableError(cls._msg)
def __radd__(cls, other):
raise UnavailableError(cls._msg)
def __iadd__(cls, other):
raise UnavailableError(cls._msg)
def __floordiv__(cls, other):
raise UnavailableError(cls._msg)
def __rfloordiv__(cls, other):
raise UnavailableError(cls._msg)
def __ifloordiv__(cls, other):
raise UnavailableError(cls._msg)
def __lshift__(cls, other):
raise UnavailableError(cls._msg)
def __rlshift__(cls, other):
raise UnavailableError(cls._msg)
def __mul__(cls, other):
raise UnavailableError(cls._msg)
def __rmul__(cls, other):
raise UnavailableError(cls._msg)
def __imul__(cls, other):
raise UnavailableError(cls._msg)
def __ilshift__(cls, other):
raise UnavailableError(cls._msg)
def __pow__(cls, other):
raise UnavailableError(cls._msg)
def __rpow__(cls, other):
raise UnavailableError(cls._msg)
def __ipow__(cls, other):
raise UnavailableError(cls._msg)
def __rshift__(cls, other):
raise UnavailableError(cls._msg)
def __rrshift__(cls, other):
raise UnavailableError(cls._msg)
def __irshift__(cls, other):
raise UnavailableError(cls._msg)
def __sub__(cls, other):
raise UnavailableError(cls._msg)
def __rsub__(cls, other):
raise UnavailableError(cls._msg)
def __isub__(cls, other):
raise UnavailableError(cls._msg)
def __truediv__(cls, other):
raise UnavailableError(cls._msg)
def __rtruediv__(cls, other):
raise UnavailableError(cls._msg)
def __itruediv__(cls, other):
raise UnavailableError(cls._msg)
def __divmod__(cls, other):
raise UnavailableError(cls._msg)
def __rdivmod__(cls, other):
raise UnavailableError(cls._msg)
def __neg__(cls):
raise UnavailableError(cls._msg)
def __invert__(cls):
raise UnavailableError(cls._msg)
def __hash__(cls):
raise UnavailableError(cls._msg)
def __index__(cls):
raise UnavailableError(cls._msg)
def __iter__(cls):
raise UnavailableError(cls._msg)
def __delitem__(cls, name):
raise UnavailableError(cls._msg)
def __setitem__(cls, name, value):
raise UnavailableError(cls._msg)
def __enter__(cls, *args, **kwargs):
raise UnavailableError(cls._msg)
def __get__(cls, *args, **kwargs):
raise UnavailableError(cls._msg)
def __delete__(cls, *args, **kwargs):
raise UnavailableError(cls._msg)
def __len__(cls):
raise UnavailableError(cls._msg)
def is_unavailable(obj):
"""Helper to check if given symbol is actually a placeholder"""
return type(obj) is UnavailableMeta
class UnavailableNullContext:
"""A placeholder class for unavailable context managers
This context manager will return a value which will throw an
UnavailableError if used in any way, but the context manager itself can be
safely invoked.
"""
def __init__(self, *args, **kwargs):
pass
def __enter__(self):
return UnavailableMeta(
"MissingContextValue",
(),
{"_msg": "Attempted to make use of placeholder context return value."},
)
def __exit__(self, *args, **kwargs):
pass
def safe_import(module, *, msg=None, alt=None):
"""A function used to import modules that may not be available
This function will attempt to import a module with the given name, but it
will not throw an ImportError if the module is not found. Instead, it will
return a placeholder object which will raise an exception only if used.
Parameters
----------
module: str
The name of the module to import.
msg: str or None
An optional error message to be displayed if this module is used
after a failed import.
alt: object
An optional module to be used in place of the given module if it
fails to import
Returns
-------
Tuple(object, bool)
The imported module, the given alternate, or a class derived from
UnavailableMeta, and a boolean indicating whether the intended import was successful.
"""
try:
return importlib.import_module(module), True
except ImportError:
exception_text = traceback.format_exc()
logger.debug(f"Import of {module} failed with: {exception_text}")
except Exception:
exception_text = traceback.format_exc()
raise
if msg is None:
msg = f"{module} could not be imported"
if alt is None:
return UnavailableMeta(module.rsplit(".")[-1], (), {"_msg": msg}), False
else:
return alt, False
def safe_import_from(module, symbol, *, msg=None, alt=None, fallback_module=None):
"""A function used to import symbols from modules that may not be available
This function will attempt to import a symbol with the given name from
the given module, but it will not throw an ImportError if the symbol is not
found. Instead, it will return a placeholder object which will raise an
exception only if used.
Parameters
----------
module: str
The name of the module in which the symbol is defined.
symbol: str
The name of the symbol to import.
msg: str or None
An optional error message to be displayed if this symbol is used
after a failed import.
alt: object
An optional object to be used in place of the given symbol if it fails
to import
fallback_module: str
Alternative name of the model in which the symbol is defined. The function will first to
import using the `module` value and if that fails will also try the `fallback_module`.
Returns
-------
Tuple(object, bool)
The imported symbol, the given alternate, or a class derived from
UnavailableMeta, and a boolean indicating whether the intended import was successful.
"""
try:
imported_module = importlib.import_module(module)
return getattr(imported_module, symbol), True
except ImportError:
exception_text = traceback.format_exc()
logger.debug(f"Import of {module} failed with: {exception_text}")
except AttributeError:
# if there is a fallback module try it.
if fallback_module is not None:
return safe_import_from(fallback_module, symbol, msg=msg, alt=alt, fallback_module=None)
exception_text = traceback.format_exc()
logger.info(f"Import of {symbol} from {module} failed with: {exception_text}")
except Exception:
exception_text = traceback.format_exc()
raise
if msg is None:
msg = f"{module}.{symbol} could not be imported"
if alt is None:
return UnavailableMeta(symbol, (), {"_msg": msg}), False
else:
return alt, False
def gpu_only_import(module, *, alt=None):
"""A function used to import modules required only in GPU installs
This function will attempt to import a module with the given name.
This function will attempt to import a symbol with the given name from
the given module, but it will not throw an ImportError if the symbol is not
found. Instead, it will return a placeholder object which will raise an
exception only if used with instructions on installing a GPU build.
Parameters
----------
module: str
The name of the module to import.
alt: object
An optional module to be used in place of the given module if it
fails to import in a non-GPU-enabled install
Returns
-------
object
The imported module, the given alternate, or a class derived from
UnavailableMeta.
"""
return safe_import(
module,
msg=f"{module} is not enabled in non GPU-enabled installations or environemnts. {GPU_INSTALL_STRING}",
alt=alt,
)
def gpu_only_import_from(module, symbol, *, alt=None):
"""A function used to import symbols required only in GPU installs
This function will attempt to import a module with the given name.
This function will attempt to import a symbol with the given name from
the given module, but it will not throw an ImportError if the symbol is not
found. Instead, it will return a placeholder object which will raise an
exception only if used with instructions on installing a GPU build.
Parameters
----------
module: str
The name of the module to import.
symbol: str
The name of the symbol to import.
alt: object
An optional object to be used in place of the given symbol if it fails
to import in a non-GPU-enabled install
Returns
-------
object
The imported symbol, the given alternate, or a class derived from
UnavailableMeta.
"""
return safe_import_from(
module,
symbol,
msg=f"{module}.{symbol} is not enabled in non GPU-enabled installations or environments. {GPU_INSTALL_STRING}",
alt=alt,
)
|