> For the complete documentation index, see [llms.txt](https://docs.seldon.ai/mlserver/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/mlserver/runtimes/alibi-detect.md).

# Alibi-Detect

This package provides a MLServer runtime compatible with [alibi-detect](https://docs.seldon.io/projects/alibi-detect/en/latest/index.html) models.

## Usage

You can install the `mlserver-alibi-detect` runtime, alongside `mlserver`, as:

```bash
pip install mlserver mlserver-alibi-detect
```

For further information on how to use MLServer with Alibi-Detect, you can check out this [worked out example](https://github.com/SeldonIO/MLServer/blob/master/docs/examples/alibi-detect/README.md).

## Content Types

If no [content type](https://github.com/SeldonIO/MLServer/blob/master/docs/user-guide/content-type/README.md) is present on the request or metadata, the Alibi-Detect runtime will try to decode the payload as a [NumPy Array](https://github.com/SeldonIO/MLServer/blob/master/docs/user-guide/content-type/README.md). To avoid this, either send a different content type explicitly, or define the correct one as part of your [model's metadata](https://github.com/SeldonIO/MLServer/blob/master/docs/reference/model-settings/README.md).

## Settings

The Alibi Detect runtime exposes a couple setting flags which can be used to customise how the runtime behaves. These settings can be added under the `parameters.extra` section of your `model-settings.json` file, e.g.

```{code-block}
---
emphasize-lines: 6-8
---
{
  "name": "drift-detector",
  "implementation": "mlserver_alibi_detect.AlibiDetectRuntime",
  "parameters": {
    "uri": "./alibi-detect-artifact/",
    "extra": {
      "batch_size": 5
    }
  }
}
```

### Reference

You can find the full reference of the accepted extra settings for the Alibi Detect runtime below:

```{eval-rst}

.. autopydantic_settings:: mlserver_alibi_detect.runtime.AlibiDetectSettings
```