> For the complete documentation index, see [llms.txt](https://docs.seldon.ai/alibi-detect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.seldon.ai/alibi-detect/api-reference/saving/schemas.md).

# alibi\_detect.saving.schemas

Pydantic models used by :func:`~alibi_detect.utils.validate.validate_config` to validate configuration dictionaries. The `resolved` kwarg of :func:`~alibi_detect.utils.validate.validate_config` determines whether the *unresolved* or *resolved* pydantic models are used:

* The *unresolved* models expect any artefacts specified within it to not yet have been resolved. The artefacts are still string references to local filepaths or registries (e.g. `x_ref = 'x_ref.npy'`).
* The *resolved* models expect all artefacts to be have been resolved into runtime objects. For example, `x_ref` should have been resolved into an `np.ndarray`.

.. note:: For detector pydantic models, the fields match the corresponding detector's args/kwargs. Refer to the detector's api docs for a full description of each arg/kwarg.

## Constants

### `supported_models_all`

```python
supported_models_all: tuple = (<class 'keras.src.models.model.Model'>, <class 'torch.nn.modules.module.Modu...
```

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

### `supported_models_tf`

```python
supported_models_tf: tuple = (<class 'keras.src.models.model.Model'>,)
```

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

### `supported_models_sklearn`

```python
supported_models_sklearn: tuple = (<class 'sklearn.base.BaseEstimator'>,)
```

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

### `supported_models_torch`

```python
supported_models_torch: tuple = (<class 'torch.nn.modules.module.Module'>,)
```

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

### `supported_optimizers_tf`

```python
supported_optimizers_tf: tuple = (<class 'keras.src.optimizers.optimizer.Optimizer'>, <class 'keras.src.optimi...
```

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

### `supported_optimizers_torch`

```python
supported_optimizers_torch: tuple = (<class 'type'>,)
```

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

### `supported_optimizers_all`

```python
supported_optimizers_all: tuple = (<class 'keras.src.optimizers.optimizer.Optimizer'>, <class 'keras.src.optimi...
```

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

### `DETECTOR_CONFIGS`

```python
DETECTOR_CONFIGS: dict = {'KSDrift': <class 'alibi_detect.saving.schemas.KSDriftConfig'>, 'ChiSquareDr...
```

### `DETECTOR_CONFIGS_RESOLVED`

```python
DETECTOR_CONFIGS_RESOLVED: dict = {'KSDrift': <class 'alibi_detect.saving.schemas.KSDriftConfigResolved'>, 'Chi...
```

## `CVMDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`CVMDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/cvmdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.CVMDrift` documentation for a description of each field.

## `CVMDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`CVMDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/cvmdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.CVMDrift` documentation for a description of each field.

## `CVMDriftOnlineConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`CVMDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinecvmdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.CVMDriftOnline` documentation for a description of each field.

## `CVMDriftOnlineConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`CVMDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinecvmdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.CVMDriftOnline` documentation for a description of each field.

## `ChiSquareDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`ChiSquareDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/chisquaredrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.ChiSquareDrift` documentation for a description of each field.

## `ChiSquareDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`ChiSquareDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/chisquaredrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.ChiSquareDrift` documentation for a description of each field.

## `ClassifierDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`ClassifierDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/classifierdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.ClassifierDrift` documentation for a description of each field.

## `ClassifierDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`ClassifierDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/classifierdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.ClassifierDrift` documentation for a description of each field.

## `ClassifierUncertaintyDriftConfig`

*Inherits from:* `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`ClassifierUncertaintyDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/modeluncdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.ClassifierUncertaintyDrift` documentation for a description of each field.

## `ClassifierUncertaintyDriftConfigResolved`

*Inherits from:* `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`ClassifierUncertaintyDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/modeluncdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.ClassifierUncertaintyDrift` documentation for a description of each field.

## `ContextMMDDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`ContextMMDDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/contextmmddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.ContextMMDDrift` documentation for a description of each field.

## `ContextMMDDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`MMDDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/mmddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.MMDDrift` documentation for a description of each field.

## `CustomBaseModel`

*Inherits from:* `BaseModel`, `Representation`

Base pydantic model schema. The default pydantic settings are set here.

## `CustomBaseModelWithKwargs`

*Inherits from:* `BaseModel`, `Representation`

Base pydantic model schema. The default pydantic settings are set here.

## `DeepKernelConfig`

*Inherits from:* `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for :class:`~alibi_detect.utils.tensorflow.kernels.DeepKernel`'s.

## `DetectorConfig`

*Inherits from:* `CustomBaseModel`, `BaseModel`, `Representation`

Base detector config schema. Only fields universal across all detectors are defined here.

## `DriftDetectorConfig`

*Inherits from:* `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved base schema for drift detectors.

## `DriftDetectorConfigResolved`

*Inherits from:* `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved base schema for drift detectors.

## `EmbeddingConfig`

*Inherits from:* `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for text embedding models. Currently, only pre-trained

`HuggingFace transformer <https://github.com/huggingface/transformers>`\_ models are supported.

## `FETDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`FETDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/fetdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.FETDrift` documentation for a description of each field.

## `FETDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`FETDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/fetdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.FETDrift` documentation for a description of each field.

## `FETDriftOnlineConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`FETDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinefetdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.FETDriftOnline` documentation for a description of each field.

## `FETDriftOnlineConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`FETDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinefetdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.FETDriftOnline` documentation for a description of each field.

## `KSDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`KSDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/ksdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.KSDrift` documentation for a description of each field.

## `KSDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`KSDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/ksdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.KSDrift` documentation for a description of each field. Resolved schema for the :class:`~alibi_detect.cd.KSDrift` detector.

## `KernelConfig`

*Inherits from:* `CustomBaseModelWithKwargs`, `BaseModel`, `Representation`

Unresolved schema for kernels, to be passed to a detector's `kernel` kwarg.

If `src` specifies a :class:`~alibi_detect.utils.tensorflow.GaussianRBF` kernel, the `sigma`, `trainable` and `init_sigma_fn` fields are passed to it. Otherwise, all fields except `src` are passed as kwargs.

## `LSDDDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`LSDDDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/lsdddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.LSDDDrift` documentation for a description of each field.

## `LSDDDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`LSDDDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/lsdddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.LSDDDrift` documentation for a description of each field.

## `LSDDDriftOnlineConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`LSDDDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinelsdddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.LSDDDriftOnline` documentation for a description of each field.

## `LSDDDriftOnlineConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`LSDDDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinelsdddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.LSDDDriftOnline` documentation for a description of each field.

## `LearnedKernelDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`LearnedKernelDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/learnedkerneldrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.LearnedKernelDrift` documentation for a description of each field.

## `LearnedKernelDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`LearnedKernelDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/learnedkerneldrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.LearnedKernelDrift` documentation for a description of each field.

## `MMDDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`MMDDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/mmddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.MMDDrift` documentation for a description of each field.

## `MMDDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`MMDDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/mmddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.MMDDrift` documentation for a description of each field.

## `MMDDriftOnlineConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`MMDDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinemmddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.MMDDriftOnline` documentation for a description of each field.

## `MMDDriftOnlineConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`MMDDriftOnline <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/onlinemmddrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.MMDDriftOnline` documentation for a description of each field.

## `MetaData`

*Inherits from:* `CustomBaseModel`, `BaseModel`, `Representation`

## `ModelConfig`

*Inherits from:* `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for (ML) models. Note that the model "backend" e.g. 'tensorflow', 'pytorch', 'sklearn', is set

by `backend` in :class:`DetectorConfig`.

## `OptimizerConfig`

*Inherits from:* `CustomBaseModelWithKwargs`, `BaseModel`, `Representation`

Unresolved schema for optimizers. The `optimizer` dictionary has two possible formats:

1. A configuration dictionary compatible with `tf.keras.optimizers.deserialize <https://www.tensorflow.org/api_docs/python/tf/keras/optimizers/deserialize>`\_. For `backend='tensorflow'` only.
2. A dictionary containing only `class_name`, where this is a string referencing the optimizer name e.g. `optimizer.class_name = 'Adam'`. In this case, the tensorflow or pytorch optimizer class of the same name is loaded. For `backend='tensorflow'` and `backend='pytorch'`.

## `PreprocessConfig`

*Inherits from:* `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for drift detector preprocess functions, to be passed to a detector's `preprocess_fn` kwarg.

Once loaded, the function is wrapped in a :func:`~functools.partial`, to be evaluated within the detector.

If `src` specifies a generic Python function, the dictionary specified by `kwargs` is passed to it. Otherwise, if `src` specifies :func:`~alibi_detect.cd.tensorflow.preprocess.preprocess_drift` (`src='@cd.tensorflow.preprocess.preprocess_drift'`), all fields (except `kwargs`) are passed to it.

## `RegressorUncertaintyDriftConfig`

*Inherits from:* `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`RegressorUncertaintyDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/modeluncdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.RegressorUncertaintyDrift` documentation for a description of each field.

## `RegressorUncertaintyDriftConfigResolved`

*Inherits from:* `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`RegressorUncertaintyDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/modeluncdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.RegressorUncertaintyDrift` documentation for a description of each field.

## `SpotTheDiffDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`SpotTheDiffDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/spotthediffdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.SpotTheDiffDrift` documentation for a description of each field.

## `SpotTheDiffDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`SpotTheDiffDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/spotthediffdrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.SpotTheDiffDrift` documentation for a description of each field.

## `SupportedDevice`

Pydantic custom type to check the device is correct for the choice of backend (conditional on what optional deps

are installed).

### Constructor

```python
SupportedDevice(self, /, *args, **kwargs)
```

### Methods

#### `validate_device`

```python
validate_device(device: typing.Any, values: dict) -> typing.Any
```

| Name     | Type         | Default | Description |
| -------- | ------------ | ------- | ----------- |
| `device` | `typing.Any` |         |             |
| `values` | `dict`       |         |             |

**Returns**

* Type: `typing.Any`

## `SupportedModel`

Pydantic custom type to check the model is one of the supported types (conditional on what optional deps

are installed).

### Constructor

```python
SupportedModel(self, /, *args, **kwargs)
```

### Methods

#### `validate_model`

```python
validate_model(model: typing.Any, values: dict) -> typing.Any
```

| Name     | Type         | Default | Description |
| -------- | ------------ | ------- | ----------- |
| `model`  | `typing.Any` |         |             |
| `values` | `dict`       |         |             |

**Returns**

* Type: `typing.Any`

## `SupportedOptimizer`

Pydantic custom type to check the optimizer is one of the supported types (conditional on what optional deps

are installed).

### Constructor

```python
SupportedOptimizer(self, /, *args, **kwargs)
```

### Methods

#### `validate_optimizer`

```python
validate_optimizer(optimizer: typing.Any, values: dict) -> typing.Any
```

| Name        | Type         | Default | Description |
| ----------- | ------------ | ------- | ----------- |
| `optimizer` | `typing.Any` |         |             |
| `values`    | `dict`       |         |             |

**Returns**

* Type: `typing.Any`

## `TabularDriftConfig`

*Inherits from:* `DriftDetectorConfig`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for the

`TabularDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/tabulardrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.TabularDrift` documentation for a description of each field.

## `TabularDriftConfigResolved`

*Inherits from:* `DriftDetectorConfigResolved`, `DetectorConfig`, `CustomBaseModel`, `BaseModel`, `Representation`

Resolved schema for the

`TabularDrift <https://docs.seldon.io/projects/alibi-detect/en/stable/cd/methods/tabulardrift.html>`\_ detector.

Except for the `name` and `meta` fields, the fields match the detector's args and kwargs. Refer to the :class:`~alibi_detect.cd.TabularDrift` documentation for a description of each field.

## `TokenizerConfig`

*Inherits from:* `CustomBaseModel`, `BaseModel`, `Representation`

Unresolved schema for text tokenizers. Currently, only pre-trained

`HuggingFace tokenizer <https://github.com/huggingface/tokenizers>`\_ models are supported.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.seldon.ai/alibi-detect/api-reference/saving/schemas.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.