validmind.errors
This module contains all the custom errors that are used in the library.
The following base errors are defined for others:
- BaseError
- APIRequestError
Common base class for all non-exit exceptions.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Generic error for API request errors that are not known.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When the test suite could not be found.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When the cache_results function is missing arguments.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When the pytorch model is missing a predict function or its predict method does not have the expected arguments.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When the test suite was found but could not be initialized.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Generic error for API request errors that are not known.
When an invalid text content_id is sent to the API.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When a figure was constructed with an unsupported for_object value.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an invalid metric results object is sent to the API.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Generic error for API request errors that are not known.
When a POST/PUT request is made with an invalid request body.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an invalid test results object is sent to the API.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an invalid parameters for the test.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an invalid input object.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an invalid Metadat (Text) object is sent to the API.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an invalid value formatter is provided when serializing results.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an invalid XGBoost trained model is used when calling init_r_model.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Exception raised when an error occurs while loading a test
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When the class labels found in the dataset don't match the provided target labels.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Common base class for all non-exit exceptions.
When the one or more class labels are missing from provided dataset targets.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When the client config is missing the documentation template.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When a required test context variable is missing.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When a required dependency is missing.
Arguments:
- message (str): The error message.
- required_dependencies (list): A list of required dependencies.
- extra (str): The particular validmind
extra
that will install the missing dependencies.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When the R extras have not been installed.
When a Text object is sent to the API without a content_id.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When a Text object is sent to the API without a "text" attribute.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Common base class for all non-exit exceptions.
When an invalid dataset is used in a test context.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an unsupported column type is found on a dataset.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an unsupported dataset is used.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an unsupported figure object is constructed.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an unsupported R model is used.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an unsupported model is used.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
When an unsupported model is used for SHAP importance.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Useful error to throw when a test cannot be executed.
Inherited Members
- builtins.BaseException
- with_traceback
- add_note
Safely try to parse JSON from the response message in case the API returns a non-JSON string or if the API returns a non-standard error
Determine whether an error should be raised when fail_fast is True.