Metadata-Version: 2.1
Name: mlserver-sklearn
Version: 1.3.4rc1
Summary: Scikit-Learn 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: # Scikit-Learn runtime for MLServer
        
        This package provides a MLServer runtime compatible with Scikit-Learn.
        
        ## Usage
        
        You can install the runtime, alongside `mlserver`, as:
        
        ```bash
        pip install mlserver mlserver-sklearn
        ```
        
        For further information on how to use MLServer with Scikit-Learn, you can check
        out this [worked out example](../../docs/examples/sklearn/README.md).
        
        ## Content Types
        
        If no [content type](../../docs/user-guide/content-type) is present on the
        request or metadata, the Scikit-Learn 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).
        
        ## Model Outputs
        
        The Scikit-Learn inference runtime exposes a number of outputs depending on the
        model type.
        These outputs match to the `predict`, `predict_proba` and `transform` methods
        of the Scikit-Learn model.
        
        | Output          | Returned By Default | Availability                                                                                                         |
        | --------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------- |
        | `predict`       | ✅                  | Available on most models, but not in [Scikit-Learn pipelines](https://scikit-learn.org/stable/modules/compose.html). |
        | `predict_proba` | ❌                  | Only available on non-regressor models.                                                                              |
        | `transform`     | ❌                  | Only availabe on [Scikit-Learn pipelines](https://scikit-learn.org/stable/modules/compose.html).                     |
        
        By default, the runtime will only return the output of `predict`.
        However, you are able to control which outputs you want back through the
        `outputs` field of your {class}`InferenceRequest
        <mlserver.types.InferenceRequest>` payload.
        
        For example, to only return the model's `predict_proba` output, you could
        define a payload such as:
        
        ```{code-block} json
        ---
        emphasize-lines: 10-12
        ---
        {
          "inputs": [
            {
              "name": "my-input",
              "datatype": "INT32",
              "shape": [2, 2],
              "data": [1, 2, 3, 4]
            }
          ],
          "outputs": [
            { "name": "predict_proba" }
          ]
        }
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
