# alibi\_detect.cd.spot\_the\_diff ## Constants ### `has_pytorch` ```python has_pytorch: bool = True ``` bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed. ### `has_tensorflow` ```python has_tensorflow: bool = True ``` bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed. ## `SpotTheDiffDrift` *Inherits from:* `DriftConfigMixin` ### Constructor ```python SpotTheDiffDrift(self, x_ref: Union[numpy.ndarray, list], backend: str = 'tensorflow', p_val: float = 0.05, x_ref_preprocessed: bool = False, preprocess_fn: Optional[Callable] = None, kernel: Callable = None, n_diffs: int = 1, initial_diffs: Optional[numpy.ndarray] = None, l1_reg: float = 0.01, binarize_preds: bool = False, train_size: Optional[float] = 0.75, n_folds: Optional[int] = None, retrain_from_scratch: bool = True, seed: int = 0, optimizer: Optional[Callable] = None, learning_rate: float = 0.001, batch_size: int = 32, preprocess_batch_fn: Optional[Callable] = None, epochs: int = 3, verbose: int = 0, train_kwargs: Optional[dict] = None, device: Union[typing_extensions.Literal['cuda', 'gpu', 'cpu'], ForwardRef('torch.device'), NoneType] = None, dataset: Optional[Callable] = None, dataloader: Optional[Callable] = None, input_shape: Optional[tuple] = None, data_type: Optional[str] = None) -> None ``` | Name | Type | Default | Description | | ---------------------- | ------------------------------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `x_ref` | `Union[numpy.ndarray, list]` | | Data used as reference distribution. | | `backend` | `str` | `'tensorflow'` | Backend used for the training loop implementation. | | `p_val` | `float` | `0.05` | p-value used for the significance of the test. | | `x_ref_preprocessed` | `bool` | `False` | Whether the given reference data `x_ref` has been preprocessed yet. If `x_ref_preprocessed=True`, only the test data `x` will be preprocessed at prediction time. If `x_ref_preprocessed=False`, the reference data will also be preprocessed. | | `preprocess_fn` | `Optional[Callable]` | `None` | Function to preprocess the data before computing the data drift metrics. | | `kernel` | `Callable` | `None` | Kernel used to define similarity between instances, defaults to Gaussian RBF | | `n_diffs` | `int` | `1` | The number of test locations to use, each corresponding to an interpretable difference. | | `initial_diffs` | `Optional[numpy.ndarray]` | `None` | Array used to initialise the diffs that will be learned. Defaults to Gaussian for each feature with equal variance to that of reference data. | | `l1_reg` | `float` | `0.01` | Strength of l1 regularisation to apply to the differences. | | `binarize_preds` | `bool` | `False` | Whether to test for discrepency on soft (e.g. probs/logits) model predictions directly with a K-S test or binarise to 0-1 prediction errors and apply a binomial test. | | `train_size` | `Optional[float]` | `0.75` | Optional fraction (float between 0 and 1) of the dataset used to train the classifier. The drift is detected on `1 - train_size`. Cannot be used in combination with `n_folds`. | | `n_folds` | `Optional[int]` | `None` | Optional number of stratified folds used for training. The model preds are then calculated on all the out-of-fold instances. This allows to leverage all the reference and test data for drift detection at the expense of longer computation. If both `train_size` and `n_folds` are specified, `n_folds` is prioritized. | | `retrain_from_scratch` | `bool` | `True` | Whether the classifier should be retrained from scratch for each set of test data or whether it should instead continue training from where it left off on the previous set. | | `seed` | `int` | `0` | Optional random seed for fold selection. | | `optimizer` | `Optional[Callable]` | `None` | Optimizer used during training of the classifier. | | `learning_rate` | `float` | `0.001` | Learning rate used by optimizer. | | `batch_size` | `int` | `32` | Batch size used during training of the classifier. | | `preprocess_batch_fn` | `Optional[Callable]` | `None` | Optional batch preprocessing function. For example to convert a list of objects to a batch which can be processed by the model. | | `epochs` | `int` | `3` | Number of training epochs for the classifier for each (optional) fold. | | `verbose` | `int` | `0` | Verbosity level during the training of the classifier. 0 is silent, 1 a progress bar. | | `train_kwargs` | `Optional[dict]` | `None` | Optional additional kwargs when fitting the classifier. | | `device` | `Union[Literal[cuda, gpu, cpu], ForwardRef('torch.device'), None]` | `None` | Device type used. The default tries to use the GPU and falls back on CPU if needed. Can be specified by passing either `'cuda'`, `'gpu'`, `'cpu'` or an instance of `torch.device`. Only relevant for 'pytorch' backend. | | `dataset` | `Optional[Callable]` | `None` | Dataset object used during training. | | `dataloader` | `Optional[Callable]` | `None` | Dataloader object used during training. Only relevant for 'pytorch' backend. | | `input_shape` | `Optional[tuple]` | `None` | Shape of input data. | | `data_type` | `Optional[str]` | `None` | Optionally specify the data type (tabular, image or time-series). Added to metadata. | ### Methods #### `predict` ```python predict(x: numpy.ndarray, return_p_val: bool = True, return_distance: bool = True, return_probs: bool = True, return_model: bool = True) -> Dict[str, Dict[str, Union[str, int, float, Callable]]] ``` Predict whether a batch of data has drifted from the reference data. | Name | Type | Default | Description | | ----------------- | --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- | | `x` | `numpy.ndarray` | | Batch of instances. | | `return_p_val` | `bool` | `True` | Whether to return the p-value of the test. | | `return_distance` | `bool` | `True` | Whether to return a notion of strength of the drift. K-S test stat if binarize\_preds=False, otherwise relative error reduction. | | `return_probs` | `bool` | `True` | Whether to return the instance level classifier probabilities for the reference and test data (0=reference data, 1=test data). | | `return_model` | `bool` | `True` | Whether to return the updated model trained to discriminate reference and test instances. | **Returns** * Type: `Dict[str, Dict[str, Union[str, int, float, Callable]]]` --- # Agent Instructions: 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: ``` GET https://docs.seldon.ai/alibi-detect/api-reference/cd/spot_the_diff.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.