exceptions Module

Contains exception module in Azure Machine Learning SDKv2.

This includes enums and classes for exceptions.

Classes

AssetException

Class for all exceptions related to Assets.

AssetPathException

Class for the exception raised when an attempt is made to update the path of an existing asset. Asset paths are immutable.

CannotSetAttributeError

Exception raised when a user try setting attributes of inputs/outputs.

CloudArtifactsNotSupportedError

Exception raised when remote cloud artifacts are used with local endpoints.

Local endpoints only support local artifacts.

ComponentException

Class for all exceptions related to Components.

DeploymentException

Class for all exceptions related to Deployments.

DockerEngineNotAvailableError

Exception raised when local Docker Engine is unavailable for local operation.

EmptyDirectoryError

Exception raised when an empty directory is provided as input for an I/O operation.

ErrorCategory
ErrorTarget
InvalidLocalEndpointError

Exception raised when local endpoint is invalid.

InvalidVSCodeRequestError

Exception raised when VS Code Debug is invoked with a remote endpoint.

VSCode debug is only supported for local endpoints.

JobException

Class for all exceptions related to Jobs.

JobParsingError

Exception that the job data returned by MFE cannot be parsed.

KeywordError

Super class of all type keyword error.

LocalDeploymentGPUNotAvailable

Exception raised when local_enable_gpu is set and Nvidia GPU is not available.

LocalEndpointImageBuildError

Exception raised when local endpoint's Docker image build is unsuccessful.

LocalEndpointInFailedStateError

Exception raised when local endpoint is in Failed state.

LocalEndpointNotFoundError

Exception raised if local endpoint cannot be found.

MissingPositionalArgsError

Exception raised when missing positional keyword parameter in dynamic functions.

MlException

The base class for all exceptions raised in AzureML SDK code base. If there is a need to define a custom exception type, that custom exception type should extend from this class.

ModelException

Class for all exceptions related to Models.

MultipleLocalDeploymentsFoundError

Exception raised when no deployment name is specified for local endpoint even though multiple deployments exist.

MultipleValueError

Exception raised when giving multiple value of a keyword parameter in dynamic functions.

ParamValueNotExistsError

Exception raised when items in non_pipeline_inputs not in keyword parameters in dynamic functions.

PipelineChildJobError

Exception that the pipeline child job is not supported.

RequiredLocalArtifactsNotFoundError

Exception raised when local artifact is not provided for local endpoint.

ScheduleException

Class for all exceptions related to Job Schedules.

TooManyPositionalArgsError

Exception raised when too many positional arguments is provided in dynamic functions.

UnexpectedAttributeError

Exception raised when an unexpected keyword is invoked by attribute, e.g. inputs.invalid_key.

UnexpectedKeywordError

Exception raised when an unexpected keyword parameter is provided in dynamic functions.

UnsupportedOperationError

Exception raised when specified operation is not supported.

UnsupportedParameterKindError

Exception raised when a user try setting attributes of inputs/outputs.

UserErrorException

Exception raised when invalid or unsupported inputs are provided.

VSCodeCommandNotFound

Exception raised when VSCode instance cannot be instantiated.

ValidationException

Class for all exceptions raised as part of client-side schema validation.

Enums

ValidationErrorType

Error types to be specified when using ValidationException class. Types are then used in raise_error.py to format a detailed error message for users.

When using ValidationException, specify the type that best describes the nature of the error being captured. If no type fits, add a new enum here and update raise_error.py to handle it.

Types of validation errors:

  • INVALID_VALUE -> One or more schema fields are invalid (e.g. incorrect type or format)

  • UNKNOWN_FIELD -> A least one unrecognized schema parameter is specified

  • MISSING_FIELD -> At least one required schema parameter is missing

  • FILE_OR_FOLDER_NOT_FOUND -> One or more files or folder paths do not exist

  • CANNOT_SERIALIZE -> Same as "Cannot dump". One or more fields cannot be serialized by marshmallow.

  • CANNOT_PARSE -> YAML file cannot be parsed

  • RESOURCE_NOT_FOUND -> Resource could not be found

  • GENERIC -> Undefined placeholder. Avoid using.