Metadata-Version: 2.1
Name: mlserver-alibi-detect
Version: 1.3.4
Summary: Alibi-Detect runtime for MLServer
Home-page: https://github.com/SeldonIO/MLServer.git
Author: Seldon Technologies Ltd.
Author-email: hello@seldon.io
License: Apache 2.0
Description: # 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
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
