# Alibi-Detect runtime for MLServer
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](../../docs/examples/alibi-detect/README.md).
## Content Types
If no [content type](../../docs/user-guide/content-type) is present on the
request or metadata, the Alibi-Detect runtime will try to decode the payload
as a [NumPy Array](../../docs/user-guide/content-type).
To avoid this, either send a different content type explicitly, or define the
correct one as part of your [model's
metadata](../../docs/reference/model-settings).
## 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} json
---
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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mlserver-alibi-detect",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Seldon Technologies Ltd.",
"author_email": "hello@seldon.io",
"download_url": "https://files.pythonhosted.org/packages/b9/48/8951a0abcc1220ac27ef5af15ce27651111aceeaf0e48f56f201de3d2b92/mlserver_alibi_detect-1.6.1.tar.gz",
"platform": null,
"description": "# Alibi-Detect runtime for MLServer\n\nThis package provides a MLServer runtime compatible with\n[alibi-detect](https://docs.seldon.io/projects/alibi-detect/en/latest/index.html)\nmodels.\n\n## Usage\n\nYou can install the `mlserver-alibi-detect` runtime, alongside `mlserver`, as:\n\n```bash\npip install mlserver mlserver-alibi-detect\n```\n\nFor further information on how to use MLServer with Alibi-Detect, you can check\nout this [worked out example](../../docs/examples/alibi-detect/README.md).\n\n## Content Types\n\nIf no [content type](../../docs/user-guide/content-type) is present on the\nrequest or metadata, the Alibi-Detect runtime will try to decode the payload\nas a [NumPy Array](../../docs/user-guide/content-type).\nTo avoid this, either send a different content type explicitly, or define the\ncorrect one as part of your [model's\nmetadata](../../docs/reference/model-settings).\n\n## Settings\n\nThe Alibi Detect runtime exposes a couple setting flags which can be used to\ncustomise how the runtime behaves.\nThese settings can be added under the `parameters.extra` section of your\n`model-settings.json` file, e.g.\n\n```{code-block} json\n---\nemphasize-lines: 6-8\n---\n{\n \"name\": \"drift-detector\",\n \"implementation\": \"mlserver_alibi_detect.AlibiDetectRuntime\",\n \"parameters\": {\n \"uri\": \"./alibi-detect-artifact/\",\n \"extra\": {\n \"batch_size\": 5\n }\n }\n}\n```\n\n### Reference\n\nYou can find the full reference of the accepted extra settings for the Alibi\nDetect runtime below:\n\n```{eval-rst}\n\n.. autopydantic_settings:: mlserver_alibi_detect.runtime.AlibiDetectSettings\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Alibi-Detect runtime for MLServer",
"version": "1.6.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7f364e240bfc352536561645cb2022c6be110e49b526ede967c0fbdc8d49a25",
"md5": "05e2ee294efc745647efadc0f91c3f35",
"sha256": "21b2550be3b74ecc48d0b41d5a789bd776f6030ea128234e61b3e468c9b47952"
},
"downloads": -1,
"filename": "mlserver_alibi_detect-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05e2ee294efc745647efadc0f91c3f35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 9255,
"upload_time": "2024-09-10T15:10:50",
"upload_time_iso_8601": "2024-09-10T15:10:50.249275Z",
"url": "https://files.pythonhosted.org/packages/b7/f3/64e240bfc352536561645cb2022c6be110e49b526ede967c0fbdc8d49a25/mlserver_alibi_detect-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9488951a0abcc1220ac27ef5af15ce27651111aceeaf0e48f56f201de3d2b92",
"md5": "b4e5b299fc5ca22228c1831f223ebcca",
"sha256": "08cd4be4f4b526a03681c4bfddb6649fc504dd72e4bc97ec69052882b6a8881b"
},
"downloads": -1,
"filename": "mlserver_alibi_detect-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "b4e5b299fc5ca22228c1831f223ebcca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 8177,
"upload_time": "2024-09-10T15:10:51",
"upload_time_iso_8601": "2024-09-10T15:10:51.378913Z",
"url": "https://files.pythonhosted.org/packages/b9/48/8951a0abcc1220ac27ef5af15ce27651111aceeaf0e48f56f201de3d2b92/mlserver_alibi_detect-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-10 15:10:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mlserver-alibi-detect"
}
JSON