alibi_detect.saving package
- alibi_detect.saving.load_detector(filepath, enable_unsafe_loading=False, **kwargs)[source]
Load outlier, drift or adversarial detector.
- Parameters:
enable_unsafe_loading (
bool
) – Sets allow_pickle=True when a np.ndarray is loaded from a .npy file referenced in the detector config. Needed if you have to load objects. Only applied if the filepath is config.toml or a directory containing a config.toml. It has security implications: https://nvd.nist.gov/vuln/detail/cve-2019-6446.
- Return type:
- Returns:
Loaded outlier or adversarial detector object.
- alibi_detect.saving.read_config(filepath)[source]
This function reads a detector toml config file and returns a dict specifying the detector.
- alibi_detect.saving.resolve_config(cfg, config_dir, enable_unsafe_loading=False)[source]
Resolves artefacts in a config dict. For example x_ref=’x_ref.npy’ is resolved by loading the np.ndarray from the .npy file. For a list of fields that are resolved, see https://docs.seldon.io/projects/alibi-detect/en/stable/overview/config_file.html.
- Parameters:
cfg (
dict
) – The unresolved config dict.config_dir (
Optional
[Path
]) – Filepath to directory the config.toml is located in. Only required if different from the runtime directory, and artefacts are specified with filepaths relative to the config.toml file.enable_unsafe_loading (
bool
) – If set to true, allow_pickle=True is set in np.load(). Needed if you have to load objects. It has security implications: https://nvd.nist.gov/vuln/detail/cve-2019-6446
- Return type:
- Returns:
The resolved config dict.
- alibi_detect.saving.save_detector(detector, filepath, legacy=False)[source]
Save outlier, drift or adversarial detector.
- Parameters:
- Return type:
- alibi_detect.saving.validate_config(cfg, resolved=False)[source]
Validates a detector config dict by passing the dict to the detector’s pydantic model schema.
- Parameters:
- Return type:
- Returns:
The validated config dict, with missing fields set to their default values.
- alibi_detect.saving.write_config(cfg, filepath)[source]
Save an unresolved detector config dict to a TOML file.
Submodules
- alibi_detect.saving.loading module
- alibi_detect.saving.registry module
- alibi_detect.saving.saving module
- alibi_detect.saving.schemas module
CVMDriftConfig
CVMDriftConfigResolved
CVMDriftOnlineConfig
CVMDriftOnlineConfigResolved
ChiSquareDriftConfig
ChiSquareDriftConfigResolved
ClassifierDriftConfig
ClassifierDriftConfig.backend
ClassifierDriftConfig.batch_size
ClassifierDriftConfig.binarize_preds
ClassifierDriftConfig.calibration_kwargs
ClassifierDriftConfig.dataloader
ClassifierDriftConfig.dataset
ClassifierDriftConfig.device
ClassifierDriftConfig.epochs
ClassifierDriftConfig.learning_rate
ClassifierDriftConfig.model
ClassifierDriftConfig.n_folds
ClassifierDriftConfig.optimizer
ClassifierDriftConfig.p_val
ClassifierDriftConfig.preds_type
ClassifierDriftConfig.preprocess_at_init
ClassifierDriftConfig.preprocess_batch_fn
ClassifierDriftConfig.reg_loss_fn
ClassifierDriftConfig.retrain_from_scratch
ClassifierDriftConfig.seed
ClassifierDriftConfig.train_kwargs
ClassifierDriftConfig.train_size
ClassifierDriftConfig.update_x_ref
ClassifierDriftConfig.use_calibration
ClassifierDriftConfig.use_oob
ClassifierDriftConfig.verbose
ClassifierDriftConfigResolved
ClassifierDriftConfigResolved.backend
ClassifierDriftConfigResolved.batch_size
ClassifierDriftConfigResolved.binarize_preds
ClassifierDriftConfigResolved.calibration_kwargs
ClassifierDriftConfigResolved.dataloader
ClassifierDriftConfigResolved.dataset
ClassifierDriftConfigResolved.device
ClassifierDriftConfigResolved.epochs
ClassifierDriftConfigResolved.learning_rate
ClassifierDriftConfigResolved.model
ClassifierDriftConfigResolved.n_folds
ClassifierDriftConfigResolved.optimizer
ClassifierDriftConfigResolved.p_val
ClassifierDriftConfigResolved.preds_type
ClassifierDriftConfigResolved.preprocess_at_init
ClassifierDriftConfigResolved.preprocess_batch_fn
ClassifierDriftConfigResolved.reg_loss_fn
ClassifierDriftConfigResolved.retrain_from_scratch
ClassifierDriftConfigResolved.seed
ClassifierDriftConfigResolved.train_kwargs
ClassifierDriftConfigResolved.train_size
ClassifierDriftConfigResolved.update_x_ref
ClassifierDriftConfigResolved.use_calibration
ClassifierDriftConfigResolved.use_oob
ClassifierDriftConfigResolved.verbose
ClassifierUncertaintyDriftConfig
ClassifierUncertaintyDriftConfig.backend
ClassifierUncertaintyDriftConfig.batch_size
ClassifierUncertaintyDriftConfig.data_type
ClassifierUncertaintyDriftConfig.device
ClassifierUncertaintyDriftConfig.input_shape
ClassifierUncertaintyDriftConfig.margin_width
ClassifierUncertaintyDriftConfig.max_len
ClassifierUncertaintyDriftConfig.model
ClassifierUncertaintyDriftConfig.p_val
ClassifierUncertaintyDriftConfig.preds_type
ClassifierUncertaintyDriftConfig.preprocess_batch_fn
ClassifierUncertaintyDriftConfig.tokenizer
ClassifierUncertaintyDriftConfig.uncertainty_type
ClassifierUncertaintyDriftConfig.update_x_ref
ClassifierUncertaintyDriftConfig.x_ref
ClassifierUncertaintyDriftConfig.x_ref_preprocessed
ClassifierUncertaintyDriftConfigResolved
ClassifierUncertaintyDriftConfigResolved.backend
ClassifierUncertaintyDriftConfigResolved.batch_size
ClassifierUncertaintyDriftConfigResolved.data_type
ClassifierUncertaintyDriftConfigResolved.device
ClassifierUncertaintyDriftConfigResolved.input_shape
ClassifierUncertaintyDriftConfigResolved.margin_width
ClassifierUncertaintyDriftConfigResolved.max_len
ClassifierUncertaintyDriftConfigResolved.model
ClassifierUncertaintyDriftConfigResolved.p_val
ClassifierUncertaintyDriftConfigResolved.preds_type
ClassifierUncertaintyDriftConfigResolved.preprocess_batch_fn
ClassifierUncertaintyDriftConfigResolved.tokenizer
ClassifierUncertaintyDriftConfigResolved.uncertainty_type
ClassifierUncertaintyDriftConfigResolved.update_x_ref
ClassifierUncertaintyDriftConfigResolved.x_ref
ClassifierUncertaintyDriftConfigResolved.x_ref_preprocessed
ContextMMDDriftConfig
ContextMMDDriftConfig.backend
ContextMMDDriftConfig.batch_size
ContextMMDDriftConfig.c_kernel
ContextMMDDriftConfig.c_ref
ContextMMDDriftConfig.device
ContextMMDDriftConfig.n_folds
ContextMMDDriftConfig.n_permutations
ContextMMDDriftConfig.p_val
ContextMMDDriftConfig.preprocess_at_init
ContextMMDDriftConfig.prop_c_held
ContextMMDDriftConfig.update_ref
ContextMMDDriftConfig.verbose
ContextMMDDriftConfig.x_kernel
ContextMMDDriftConfigResolved
ContextMMDDriftConfigResolved.backend
ContextMMDDriftConfigResolved.batch_size
ContextMMDDriftConfigResolved.c_kernel
ContextMMDDriftConfigResolved.c_ref
ContextMMDDriftConfigResolved.device
ContextMMDDriftConfigResolved.n_folds
ContextMMDDriftConfigResolved.n_permutations
ContextMMDDriftConfigResolved.p_val
ContextMMDDriftConfigResolved.preprocess_at_init
ContextMMDDriftConfigResolved.prop_c_held
ContextMMDDriftConfigResolved.update_ref
ContextMMDDriftConfigResolved.verbose
ContextMMDDriftConfigResolved.x_kernel
CustomBaseModel
CustomBaseModelWithKwargs
DeepKernelConfig
DetectorConfig
DriftDetectorConfig
DriftDetectorConfigResolved
EmbeddingConfig
FETDriftConfig
FETDriftConfigResolved
FETDriftOnlineConfig
FETDriftOnlineConfigResolved
FETDriftOnlineConfigResolved.alternative
FETDriftOnlineConfigResolved.ert
FETDriftOnlineConfigResolved.lam
FETDriftOnlineConfigResolved.n_bootstraps
FETDriftOnlineConfigResolved.n_features
FETDriftOnlineConfigResolved.t_max
FETDriftOnlineConfigResolved.verbose
FETDriftOnlineConfigResolved.window_sizes
KSDriftConfig
KSDriftConfigResolved
KernelConfig
LSDDDriftConfig
LSDDDriftConfigResolved
LSDDDriftConfigResolved.backend
LSDDDriftConfigResolved.device
LSDDDriftConfigResolved.lambda_rd_max
LSDDDriftConfigResolved.n_kernel_centers
LSDDDriftConfigResolved.n_permutations
LSDDDriftConfigResolved.p_val
LSDDDriftConfigResolved.preprocess_at_init
LSDDDriftConfigResolved.sigma
LSDDDriftConfigResolved.update_x_ref
LSDDDriftOnlineConfig
LSDDDriftOnlineConfigResolved
LSDDDriftOnlineConfigResolved.backend
LSDDDriftOnlineConfigResolved.device
LSDDDriftOnlineConfigResolved.ert
LSDDDriftOnlineConfigResolved.lambda_rd_max
LSDDDriftOnlineConfigResolved.n_bootstraps
LSDDDriftOnlineConfigResolved.n_kernel_centers
LSDDDriftOnlineConfigResolved.sigma
LSDDDriftOnlineConfigResolved.verbose
LSDDDriftOnlineConfigResolved.window_size
LearnedKernelDriftConfig
LearnedKernelDriftConfig.backend
LearnedKernelDriftConfig.batch_size
LearnedKernelDriftConfig.batch_size_permutations
LearnedKernelDriftConfig.batch_size_predict
LearnedKernelDriftConfig.dataloader
LearnedKernelDriftConfig.dataset
LearnedKernelDriftConfig.device
LearnedKernelDriftConfig.epochs
LearnedKernelDriftConfig.kernel
LearnedKernelDriftConfig.learning_rate
LearnedKernelDriftConfig.n_permutations
LearnedKernelDriftConfig.num_workers
LearnedKernelDriftConfig.optimizer
LearnedKernelDriftConfig.p_val
LearnedKernelDriftConfig.preprocess_at_init
LearnedKernelDriftConfig.preprocess_batch_fn
LearnedKernelDriftConfig.reg_loss_fn
LearnedKernelDriftConfig.retrain_from_scratch
LearnedKernelDriftConfig.train_kwargs
LearnedKernelDriftConfig.train_size
LearnedKernelDriftConfig.update_x_ref
LearnedKernelDriftConfig.var_reg
LearnedKernelDriftConfig.verbose
LearnedKernelDriftConfigResolved
LearnedKernelDriftConfigResolved.backend
LearnedKernelDriftConfigResolved.batch_size
LearnedKernelDriftConfigResolved.batch_size_permutations
LearnedKernelDriftConfigResolved.batch_size_predict
LearnedKernelDriftConfigResolved.dataloader
LearnedKernelDriftConfigResolved.dataset
LearnedKernelDriftConfigResolved.device
LearnedKernelDriftConfigResolved.epochs
LearnedKernelDriftConfigResolved.kernel
LearnedKernelDriftConfigResolved.learning_rate
LearnedKernelDriftConfigResolved.n_permutations
LearnedKernelDriftConfigResolved.num_workers
LearnedKernelDriftConfigResolved.optimizer
LearnedKernelDriftConfigResolved.p_val
LearnedKernelDriftConfigResolved.preprocess_at_init
LearnedKernelDriftConfigResolved.preprocess_batch_fn
LearnedKernelDriftConfigResolved.reg_loss_fn
LearnedKernelDriftConfigResolved.retrain_from_scratch
LearnedKernelDriftConfigResolved.train_kwargs
LearnedKernelDriftConfigResolved.train_size
LearnedKernelDriftConfigResolved.update_x_ref
LearnedKernelDriftConfigResolved.var_reg
LearnedKernelDriftConfigResolved.verbose
MMDDriftConfig
MMDDriftConfigResolved
MMDDriftConfigResolved.backend
MMDDriftConfigResolved.batch_size_permutations
MMDDriftConfigResolved.configure_kernel_from_x_ref
MMDDriftConfigResolved.device
MMDDriftConfigResolved.kernel
MMDDriftConfigResolved.n_permutations
MMDDriftConfigResolved.p_val
MMDDriftConfigResolved.preprocess_at_init
MMDDriftConfigResolved.sigma
MMDDriftConfigResolved.update_x_ref
MMDDriftOnlineConfig
MMDDriftOnlineConfigResolved
MetaData
ModelConfig
OptimizerConfig
PreprocessConfig
RegressorUncertaintyDriftConfig
RegressorUncertaintyDriftConfig.backend
RegressorUncertaintyDriftConfig.batch_size
RegressorUncertaintyDriftConfig.data_type
RegressorUncertaintyDriftConfig.device
RegressorUncertaintyDriftConfig.input_shape
RegressorUncertaintyDriftConfig.max_len
RegressorUncertaintyDriftConfig.model
RegressorUncertaintyDriftConfig.n_evals
RegressorUncertaintyDriftConfig.p_val
RegressorUncertaintyDriftConfig.preprocess_batch_fn
RegressorUncertaintyDriftConfig.tokenizer
RegressorUncertaintyDriftConfig.uncertainty_type
RegressorUncertaintyDriftConfig.update_x_ref
RegressorUncertaintyDriftConfig.x_ref
RegressorUncertaintyDriftConfig.x_ref_preprocessed
RegressorUncertaintyDriftConfigResolved
RegressorUncertaintyDriftConfigResolved.backend
RegressorUncertaintyDriftConfigResolved.batch_size
RegressorUncertaintyDriftConfigResolved.data_type
RegressorUncertaintyDriftConfigResolved.device
RegressorUncertaintyDriftConfigResolved.input_shape
RegressorUncertaintyDriftConfigResolved.max_len
RegressorUncertaintyDriftConfigResolved.model
RegressorUncertaintyDriftConfigResolved.n_evals
RegressorUncertaintyDriftConfigResolved.p_val
RegressorUncertaintyDriftConfigResolved.preprocess_batch_fn
RegressorUncertaintyDriftConfigResolved.tokenizer
RegressorUncertaintyDriftConfigResolved.uncertainty_type
RegressorUncertaintyDriftConfigResolved.update_x_ref
RegressorUncertaintyDriftConfigResolved.x_ref
RegressorUncertaintyDriftConfigResolved.x_ref_preprocessed
SpotTheDiffDriftConfig
SpotTheDiffDriftConfig.backend
SpotTheDiffDriftConfig.batch_size
SpotTheDiffDriftConfig.binarize_preds
SpotTheDiffDriftConfig.dataloader
SpotTheDiffDriftConfig.dataset
SpotTheDiffDriftConfig.device
SpotTheDiffDriftConfig.epochs
SpotTheDiffDriftConfig.initial_diffs
SpotTheDiffDriftConfig.kernel
SpotTheDiffDriftConfig.l1_reg
SpotTheDiffDriftConfig.learning_rate
SpotTheDiffDriftConfig.n_diffs
SpotTheDiffDriftConfig.n_folds
SpotTheDiffDriftConfig.optimizer
SpotTheDiffDriftConfig.p_val
SpotTheDiffDriftConfig.preprocess_batch_fn
SpotTheDiffDriftConfig.retrain_from_scratch
SpotTheDiffDriftConfig.seed
SpotTheDiffDriftConfig.train_kwargs
SpotTheDiffDriftConfig.train_size
SpotTheDiffDriftConfig.verbose
SpotTheDiffDriftConfigResolved
SpotTheDiffDriftConfigResolved.backend
SpotTheDiffDriftConfigResolved.batch_size
SpotTheDiffDriftConfigResolved.binarize_preds
SpotTheDiffDriftConfigResolved.dataloader
SpotTheDiffDriftConfigResolved.dataset
SpotTheDiffDriftConfigResolved.device
SpotTheDiffDriftConfigResolved.epochs
SpotTheDiffDriftConfigResolved.initial_diffs
SpotTheDiffDriftConfigResolved.kernel
SpotTheDiffDriftConfigResolved.l1_reg
SpotTheDiffDriftConfigResolved.learning_rate
SpotTheDiffDriftConfigResolved.n_diffs
SpotTheDiffDriftConfigResolved.n_folds
SpotTheDiffDriftConfigResolved.optimizer
SpotTheDiffDriftConfigResolved.p_val
SpotTheDiffDriftConfigResolved.preprocess_batch_fn
SpotTheDiffDriftConfigResolved.retrain_from_scratch
SpotTheDiffDriftConfigResolved.seed
SpotTheDiffDriftConfigResolved.train_kwargs
SpotTheDiffDriftConfigResolved.train_size
SpotTheDiffDriftConfigResolved.verbose
SupportedDevice
SupportedModel
SupportedOptimizer
TabularDriftConfig
TabularDriftConfigResolved
TokenizerConfig
- alibi_detect.saving.validate module
- alibi_detect.saving.validators module