validmind.errors

This module contains all the custom errors that are used in the ValidMind Library.

The following base errors are defined for others:

Base errors

BaseError

classBaseError(Exception):

Common base class for all non-exit exceptions.

BaseError

BaseError(message='')

description

defdescription(self,*args,**kwargs):

Inherited members

  • builtins.BaseException with_traceback, add_note

APIRequestError

classAPIRequestError(BaseError):

Generic error for API request errors that are not known.

Inherited members

API errors

InvalidAPICredentialsError

classInvalidAPICredentialsError(APIRequestError):

Inherited members

MissingAPICredentialsError

classMissingAPICredentialsError(BaseError):

Inherited members

Model errors

InvalidXGBoostTrainedModelError

classInvalidXGBoostTrainedModelError(BaseError):

When an invalid XGBoost trained model is used when calling init_r_model.

Inherited members

MissingModelIdError

classMissingModelIdError(BaseError):

Inherited members

MissingOrInvalidModelPredictFnError

classMissingOrInvalidModelPredictFnError(BaseError):

When the PyTorch model is missing a predict function or its predict method does not have the expected arguments.

Inherited members

UnsupportedModelError

classUnsupportedModelError(BaseError):

When an unsupported model is used.

Inherited members

UnsupportedModelForSHAPError

classUnsupportedModelForSHAPError(BaseError):

When an unsupported model is used for SHAP importance.

Inherited members

UnsupportedRModelError

classUnsupportedRModelError(BaseError):

When an unsupported R model is used.

Inherited members

Test errors

GetTestSuiteError

classGetTestSuiteError(BaseError):

When the test suite could not be found.

Inherited members

InitializeTestSuiteError

classInitializeTestSuiteError(BaseError):

When the test suite was found but could not be initialized.

Inherited members

InvalidTestParametersError

classInvalidTestParametersError(BaseError):

When invalid parameters are provided for the test.

Inherited members

InvalidTestResultsError

classInvalidTestResultsError(APIRequestError):

When an invalid test results object is sent to the API.

Inherited members

LoadTestError

classLoadTestError(BaseError):

Exception raised when an error occurs while loading a test.

Inherited members

MissingRequiredTestInputError

classMissingRequiredTestInputError(BaseError):

When a required test context variable is missing.

Inherited members

SkipTestError

classSkipTestError(BaseError):

Useful error to throw when a test cannot be executed.

Inherited members

TestInputInvalidDatasetError

classTestInputInvalidDatasetError(BaseError):

When an invalid dataset is used in a test context.

Inherited members

Input validation errors

InvalidXGBoostTrainedModelError

classInvalidXGBoostTrainedModelError(BaseError):

When an invalid XGBoost trained model is used when calling init_r_model.

Inherited members

MissingModelIdError

classMissingModelIdError(BaseError):

Inherited members

MissingOrInvalidModelPredictFnError

classMissingOrInvalidModelPredictFnError(BaseError):

When the PyTorch model is missing a predict function or its predict method does not have the expected arguments.

Inherited members

InvalidTestParametersError

classInvalidTestParametersError(BaseError):

When invalid parameters are provided for the test.

Inherited members

InvalidTestResultsError

classInvalidTestResultsError(APIRequestError):

When an invalid test results object is sent to the API.

Inherited members

MissingRequiredTestInputError

classMissingRequiredTestInputError(BaseError):

When a required test context variable is missing.

Inherited members

InvalidAPICredentialsError

classInvalidAPICredentialsError(APIRequestError):

Inherited members

InvalidContentIdPrefixError

classInvalidContentIdPrefixError(APIRequestError):

When an invalid text content_id is sent to the API.

Inherited members

InvalidInputError

classInvalidInputError(BaseError):

When an invalid input object is provided.

Inherited members

InvalidMetricResultsError

classInvalidMetricResultsError(APIRequestError):

When an invalid metric results object is sent to the API.

Inherited members

InvalidParameterError

classInvalidParameterError(BaseError):

When an invalid parameter is provided.

Inherited members

InvalidProjectError

classInvalidProjectError(APIRequestError):

Inherited members

InvalidRequestBodyError

classInvalidRequestBodyError(APIRequestError):

When a POST/PUT request is made with an invalid request body.

Inherited members

InvalidTextObjectError

classInvalidTextObjectError(APIRequestError):

When an invalid Metadata (Text) object is sent to the API.

Inherited members

InvalidValueFormatterError

classInvalidValueFormatterError(BaseError):

When an invalid value formatter is provided when serializing results.

Inherited members

MissingAPICredentialsError

classMissingAPICredentialsError(BaseError):

Inherited members

MissingCacheResultsArgumentsError

classMissingCacheResultsArgumentsError(BaseError):

When the cache_results function is missing arguments.

Inherited members

MissingClassLabelError

classMissingClassLabelError(BaseError):

When the one or more class labels are missing from provided dataset targets.

Inherited members

MissingDependencyError

classMissingDependencyError(BaseError):

When a required dependency is missing.

Inherited members

MissingDocumentationTemplate

classMissingDocumentationTemplate(BaseError):

When the client config is missing the documentation template.

Inherited members

MissingRExtrasError

classMissingRExtrasError(BaseError):

When the R extras have not been installed.

Inherited members

MissingTextContentIdError

classMissingTextContentIdError(APIRequestError):

When a Text object is sent to the API without a content_id.

Inherited members

MissingTextContentsError

classMissingTextContentsError(APIRequestError):

When a Text object is sent to the API without a "text" attribute.

Inherited members

Unsupported feature errors

UnsupportedModelError

classUnsupportedModelError(BaseError):

When an unsupported model is used.

Inherited members

UnsupportedModelForSHAPError

classUnsupportedModelForSHAPError(BaseError):

When an unsupported model is used for SHAP importance.

Inherited members

UnsupportedRModelError

classUnsupportedRModelError(BaseError):

When an unsupported R model is used.

Inherited members

UnsupportedColumnTypeError

classUnsupportedColumnTypeError(BaseError):

When an unsupported column type is found on a dataset.

Inherited members

UnsupportedDatasetError

classUnsupportedDatasetError(BaseError):

When an unsupported dataset is used.

Inherited members

UnsupportedFigureError

classUnsupportedFigureError(BaseError):

When an unsupported figure object is constructed.

Inherited members