Module furiosa.runtime.furiosa_sdk_runtime.errors
Nux Exception and Error
Expand source code
"""Nux Exception and Error"""
from enum import IntEnum
from typing import Optional
class NativeError(IntEnum):
"""Python object correspondnig to nux_error_t in Nux C API"""
SUCCESS = 0
NUX_CREATION_FAILED = 1
MODEL_DEPLOY_FAILED = 2
MODEL_EXECUTION_FAILED = 3
INVALID_INPUT_INDEX = 4
INVALID_OUTPUT_INDEX = 5
INVALID_BUFFER = 6
INVALID_INPUTS = 7
INVALID_OUTPUTS = 8
GET_TASK_FAILED = 9
DUMP_PROFILE_FAILED = 10
QUEUE_WAIT_TIMEOUT = 11
QUEUE_NO_DATA = 12
INCOMPATIBLE_MODEL = 13
COMPILATION_FAILED = 14
INTERNAL_ERROR = 15
INVALID_YAML = 16
INCOMPATIBLE_API_CLIENT_ERROR = 17
API_CLIENT_INIT_FAILED = 18
NO_API_KEY = 19
def is_ok(err: NativeError) -> bool:
"""True if NuxErr is SUCCESS, or False"""
return err == NativeError.SUCCESS
def is_err(self) -> bool:
"""True if NuxErr is not SUCCESS, or False"""
return self != NativeError.SUCCESS
class NuxException(Exception):
"""general exception caused by Nuxpy"""
native_err: Optional[NativeError]
msg: str
def __init__(self, msg: str, native_err: NativeError = None):
self.native_err = native_err
self.msg = msg
super().__init__(self)
def message(self) -> str:
"""Error message"""
return self.msg
def native_error(self) -> Optional[NativeError]:
"""Return a native error if this exception comes from C native extension"""
return self.native_err
def __repr__(self):
if self.native_err is None:
return '{}'.format(self.msg)
return '{} (native error code: {})'.format(self.msg, self.native_err)
def __str__(self):
return self.__repr__()
class IncompatibleModel(NuxException):
"""When Renegade compiler cannot recognize a given model image binary"""
def __init__(self):
super().__init__("Model binary is not compatible",
NativeError.INCOMPATIBLE_MODEL)
class CompilationFailed(NuxException):
"""when Nux fails to compile a given model image to NPU model binary"""
def __init__(self):
super().__init__("fail to compile a given model to NPU binary",
NativeError.COMPILATION_FAILED)
class InternalError(NuxException):
"""internal error or no corresponding error in Python binding"""
def __init__(self, cause='unknown'):
super().__init__("{}".format(cause), NativeError.INTERNAL_ERROR)
class UnsupportedTensorType(NuxException):
"""Unsupported tensor type"""
def __init__(self):
super().__init__("numpy.ndarray, TensorArray are only supported",
NativeError.INVALID_INPUTS)
class UnsupportedDataType(NuxException):
"""Unsupported tensor data type"""
def __init__(self, dtype):
super().__init__(msg="unknown data type: {}".format(dtype))
class IncompatibleApiClientError(NuxException):
"""When both API client and server are incompatible"""
def __init__(self):
super().__init__("incompatible client with Furiosa API server",
NativeError.INCOMPATIBLE_API_CLIENT_ERROR)
class InvalidYamlException(NuxException):
"""When Renegade compiler cannot recognize a given model image binary"""
def __init__(self):
super().__init__("Compiler config is not valid YAML",
NativeError.INVALID_YAML)
class ApiClientInitFailed(NuxException):
"""when api client fails to initialize due to api keys or others"""
def __init__(self):
super().__init__("fail to initialize API client",
NativeError.API_CLIENT_INIT_FAILED)
class NoApiKeyException(NuxException):
"""when api client fails to initialize due to api keys or others"""
def __init__(self):
super().__init__("No API keys. Please check your API keys.",
NativeError.NO_API_KEY)
_errors_to_exceptions = {
NativeError.INCOMPATIBLE_MODEL: IncompatibleModel(),
NativeError.COMPILATION_FAILED: CompilationFailed(),
NativeError.INTERNAL_ERROR: InternalError(),
NativeError.INCOMPATIBLE_API_CLIENT_ERROR: IncompatibleApiClientError(),
NativeError.INVALID_YAML: InvalidYamlException(),
NativeError.API_CLIENT_INIT_FAILED: ApiClientInitFailed(),
NativeError.NO_API_KEY: NoApiKeyException(),
}
def into_exception(err: NativeError) -> NuxException:
"""
Convert nux_error_t type in Nux C API to NuxException
:param err: integer value of nux_error_t enum
:return: NuxException
"""
if err == NativeError.SUCCESS:
return RuntimeError(msg='NuxErr.SUCCESS cannot be NuxException')
if err in _errors_to_exceptions.keys():
return _errors_to_exceptions[err]
return InternalError()
Functions
def into_exception(err: NativeError) ‑> NuxException
-
Convert nux_error_t type in Nux C API to NuxException
:param err: integer value of nux_error_t enum :return: NuxException
Expand source code
def into_exception(err: NativeError) -> NuxException: """ Convert nux_error_t type in Nux C API to NuxException :param err: integer value of nux_error_t enum :return: NuxException """ if err == NativeError.SUCCESS: return RuntimeError(msg='NuxErr.SUCCESS cannot be NuxException') if err in _errors_to_exceptions.keys(): return _errors_to_exceptions[err] return InternalError()
def is_err(self) ‑> bool
-
True if NuxErr is not SUCCESS, or False
Expand source code
def is_err(self) -> bool: """True if NuxErr is not SUCCESS, or False""" return self != NativeError.SUCCESS
def is_ok(err: NativeError) ‑> bool
-
True if NuxErr is SUCCESS, or False
Expand source code
def is_ok(err: NativeError) -> bool: """True if NuxErr is SUCCESS, or False""" return err == NativeError.SUCCESS
Classes
class ApiClientInitFailed
-
when api client fails to initialize due to api keys or others
Expand source code
class ApiClientInitFailed(NuxException): """when api client fails to initialize due to api keys or others""" def __init__(self): super().__init__("fail to initialize API client", NativeError.API_CLIENT_INIT_FAILED)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class CompilationFailed
-
when Nux fails to compile a given model image to NPU model binary
Expand source code
class CompilationFailed(NuxException): """when Nux fails to compile a given model image to NPU model binary""" def __init__(self): super().__init__("fail to compile a given model to NPU binary", NativeError.COMPILATION_FAILED)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class IncompatibleApiClientError
-
When both API client and server are incompatible
Expand source code
class IncompatibleApiClientError(NuxException): """When both API client and server are incompatible""" def __init__(self): super().__init__("incompatible client with Furiosa API server", NativeError.INCOMPATIBLE_API_CLIENT_ERROR)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class IncompatibleModel
-
When Renegade compiler cannot recognize a given model image binary
Expand source code
class IncompatibleModel(NuxException): """When Renegade compiler cannot recognize a given model image binary""" def __init__(self): super().__init__("Model binary is not compatible", NativeError.INCOMPATIBLE_MODEL)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class InternalError (cause='unknown')
-
internal error or no corresponding error in Python binding
Expand source code
class InternalError(NuxException): """internal error or no corresponding error in Python binding""" def __init__(self, cause='unknown'): super().__init__("{}".format(cause), NativeError.INTERNAL_ERROR)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class InvalidYamlException
-
When Renegade compiler cannot recognize a given model image binary
Expand source code
class InvalidYamlException(NuxException): """When Renegade compiler cannot recognize a given model image binary""" def __init__(self): super().__init__("Compiler config is not valid YAML", NativeError.INVALID_YAML)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class NativeError (value, names=None, *, module=None, qualname=None, type=None, start=1)
-
Python object correspondnig to nux_error_t in Nux C API
Expand source code
class NativeError(IntEnum): """Python object correspondnig to nux_error_t in Nux C API""" SUCCESS = 0 NUX_CREATION_FAILED = 1 MODEL_DEPLOY_FAILED = 2 MODEL_EXECUTION_FAILED = 3 INVALID_INPUT_INDEX = 4 INVALID_OUTPUT_INDEX = 5 INVALID_BUFFER = 6 INVALID_INPUTS = 7 INVALID_OUTPUTS = 8 GET_TASK_FAILED = 9 DUMP_PROFILE_FAILED = 10 QUEUE_WAIT_TIMEOUT = 11 QUEUE_NO_DATA = 12 INCOMPATIBLE_MODEL = 13 COMPILATION_FAILED = 14 INTERNAL_ERROR = 15 INVALID_YAML = 16 INCOMPATIBLE_API_CLIENT_ERROR = 17 API_CLIENT_INIT_FAILED = 18 NO_API_KEY = 19
Ancestors
- enum.IntEnum
- builtins.int
- enum.Enum
Class variables
var API_CLIENT_INIT_FAILED
var COMPILATION_FAILED
var DUMP_PROFILE_FAILED
var GET_TASK_FAILED
var INCOMPATIBLE_API_CLIENT_ERROR
var INCOMPATIBLE_MODEL
var INTERNAL_ERROR
var INVALID_BUFFER
var INVALID_INPUTS
var INVALID_INPUT_INDEX
var INVALID_OUTPUTS
var INVALID_OUTPUT_INDEX
var INVALID_YAML
var MODEL_DEPLOY_FAILED
var MODEL_EXECUTION_FAILED
var NO_API_KEY
var NUX_CREATION_FAILED
var QUEUE_NO_DATA
var QUEUE_WAIT_TIMEOUT
var SUCCESS
class NoApiKeyException
-
when api client fails to initialize due to api keys or others
Expand source code
class NoApiKeyException(NuxException): """when api client fails to initialize due to api keys or others""" def __init__(self): super().__init__("No API keys. Please check your API keys.", NativeError.NO_API_KEY)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class NuxException (msg: str, native_err: NativeError = None)
-
general exception caused by Nuxpy
Expand source code
class NuxException(Exception): """general exception caused by Nuxpy""" native_err: Optional[NativeError] msg: str def __init__(self, msg: str, native_err: NativeError = None): self.native_err = native_err self.msg = msg super().__init__(self) def message(self) -> str: """Error message""" return self.msg def native_error(self) -> Optional[NativeError]: """Return a native error if this exception comes from C native extension""" return self.native_err def __repr__(self): if self.native_err is None: return '{}'.format(self.msg) return '{} (native error code: {})'.format(self.msg, self.native_err) def __str__(self): return self.__repr__()
Ancestors
- builtins.Exception
- builtins.BaseException
Subclasses
- ApiClientInitFailed
- CompilationFailed
- IncompatibleApiClientError
- IncompatibleModel
- InternalError
- InvalidYamlException
- NoApiKeyException
- UnsupportedDataType
- UnsupportedTensorType
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Methods
def message(self) ‑> str
-
Error message
Expand source code
def message(self) -> str: """Error message""" return self.msg
def native_error(self) ‑> Union[NativeError, NoneType]
-
Return a native error if this exception comes from C native extension
Expand source code
def native_error(self) -> Optional[NativeError]: """Return a native error if this exception comes from C native extension""" return self.native_err
class UnsupportedDataType (dtype)
-
Unsupported tensor data type
Expand source code
class UnsupportedDataType(NuxException): """Unsupported tensor data type""" def __init__(self, dtype): super().__init__(msg="unknown data type: {}".format(dtype))
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members
class UnsupportedTensorType
-
Unsupported tensor type
Expand source code
class UnsupportedTensorType(NuxException): """Unsupported tensor type""" def __init__(self): super().__init__("numpy.ndarray, TensorArray are only supported", NativeError.INVALID_INPUTS)
Ancestors
- NuxException
- builtins.Exception
- builtins.BaseException
Class variables
var msg : str
var native_err : Union[NativeError, NoneType]
Inherited members