nemo_automodel.shared.import_utils

Module Contents

Classes

UnavailableMeta

A metaclass for generating placeholder objects for unavailable symbols.

Functions

null_decorator	No-op decorator.
is_unavailable	Helper to check if given symbol is actually a placeholder.
safe_import	A function used to import modules that may not be available.
safe_import_from	A function used to import symbols from modules that may not be available.
gpu_only_import	A function used to import modules required only in GPU installs.
gpu_only_import_from	A function used to import symbols required only in GPU installs.
get_torch_version	Return pytorch version with fallback if unavailable.
is_torch_min_version	Check if minimum version of torch is installed.

Data

logger
GPU_INSTALL_STRING
MISSING_TRITON_MSG
MISSING_QWEN_VL_UTILS_MSG
MISSING_CUT_CROSS_ENTROPY_MSG

API

nemo_automodel.shared.import_utils.logger

‘getLogger(…)’

nemo_automodel.shared.import_utils.GPU_INSTALL_STRING = <Multiline-String>

nemo_automodel.shared.import_utils.MISSING_TRITON_MSG

‘triton is not installed. Please install it with pip install triton.’

nemo_automodel.shared.import_utils.MISSING_QWEN_VL_UTILS_MSG

‘qwen_vl_utils is not installed. Please install it with pip install qwen-vl-utils.’

nemo_automodel.shared.import_utils.MISSING_CUT_CROSS_ENTROPY_MSG

‘cut_cross_entropy is not installed. Please install it with pip install cut-cross-entropy.’

exception nemo_automodel.shared.import_utils.UnavailableError

Bases: Exception

Error thrown if a symbol is unavailable due to an issue importing it.

Initialization

Initialize self. See help(type(self)) for accurate signature.

nemo_automodel.shared.import_utils.null_decorator(*args, **kwargs)

No-op decorator.

class nemo_automodel.shared.import_utils.UnavailableMeta

Bases: 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.

__new__(name, bases, dct)

__call__(*args, **kwargs)

__getattr__(name)

__eq__(other)

__lt__(other)

__gt__(other)

__le__(other)

__ge__(other)

__ne__(other)

__abs__()

__add__(other)

__radd__(other)

__iadd__(other)

__floordiv__(other)

__rfloordiv__(other)

__ifloordiv__(other)

__lshift__(other)

__rlshift__(other)

__mul__(other)

__rmul__(other)

__imul__(other)

__ilshift__(other)

__pow__(other)

__rpow__(other)

__ipow__(other)

__rshift__(other)

__rrshift__(other)

__irshift__(other)

__sub__(other)

__rsub__(other)

__isub__(other)

__truediv__(other)

__rtruediv__(other)

__itruediv__(other)

__divmod__(other)

__rdivmod__(other)

__neg__()

__invert__()

__hash__()

__index__()

__iter__()

__delitem__(name)

__setitem__(name, value)

__enter__(*args, **kwargs)

__get__(*args, **kwargs)

__delete__(*args, **kwargs)

__len__()

nemo_automodel.shared.import_utils.is_unavailable(obj)

Helper to check if given symbol is actually a placeholder.

nemo_automodel.shared.import_utils.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:

The imported module, the given alternate, or a class derived from UnavailableMeta, and a boolean indicating whether the intended import was successful.

Return type:

Tuple(bool, object)

nemo_automodel.shared.import_utils.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:

The imported symbol, the given alternate, or a class derived from UnavailableMeta, and a boolean indicating whether the intended import was successful.

Return type:

Tuple(object, bool)

nemo_automodel.shared.import_utils.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:

The imported module, the given alternate, or a class derived from UnavailableMeta.

Return type:

object

nemo_automodel.shared.import_utils.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:

The imported symbol, the given alternate, or a class derived from UnavailableMeta.

Return type:

object

nemo_automodel.shared.import_utils.get_torch_version()

Return pytorch version with fallback if unavailable.

Returns:

Pytorch’s version

Return type:

PkgVersion

nemo_automodel.shared.import_utils.is_torch_min_version(version, check_equality=True)

Check if minimum version of torch is installed.