Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Alibi Explain to list of runtimes #902

Merged
merged 1 commit into from
Dec 14, 2022
Merged

Add Alibi Explain to list of runtimes #902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,17 @@ runtimes](./docs/runtimes/custom.md)**.

Out of the box, MLServer provides support for:

| Framework | Supported | Documentation |
| ------------ | --------- | ---------------------------------------------------------------- |
| Scikit-Learn | ✅ | [MLServer SKLearn](./runtimes/sklearn) |
| XGBoost | ✅ | [MLServer XGBoost](./runtimes/xgboost) |
| Spark MLlib | ✅ | [MLServer MLlib](./runtimes/mllib) |
| LightGBM | ✅ | [MLServer LightGBM](./runtimes/lightgbm) |
| Tempo | ✅ | [`github.com/SeldonIO/tempo`](https://github.com/SeldonIO/tempo) |
| MLflow | ✅ | [MLServer MLflow](./runtimes/mlflow) |
| Alibi-Detect | ✅ | [MLServer Alibi Detect](./runtimes/alibi-detect) |
| HuggingFace | ✅ | [MLServer HuggingFace](./runtimes/huggingface) |
| Framework | Supported | Documentation |
| ------------- | --------- | ---------------------------------------------------------------- |
| Scikit-Learn | ✅ | [MLServer SKLearn](./runtimes/sklearn) |
| XGBoost | ✅ | [MLServer XGBoost](./runtimes/xgboost) |
| Spark MLlib | ✅ | [MLServer MLlib](./runtimes/mllib) |
| LightGBM | ✅ | [MLServer LightGBM](./runtimes/lightgbm) |
| Tempo | ✅ | [`github.com/SeldonIO/tempo`](https://github.com/SeldonIO/tempo) |
| MLflow | ✅ | [MLServer MLflow](./runtimes/mlflow) |
| Alibi-Detect | ✅ | [MLServer Alibi Detect](./runtimes/alibi-detect) |
| Alibi-Explain | ✅ | [MLServer Alibi Explain](./runtimes/alibi-explain) |
| HuggingFace | ✅ | [MLServer HuggingFace](./runtimes/huggingface) |

## Examples

Expand Down
3 changes: 3 additions & 0 deletions docs/runtimes/alibi-explain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```{include} ../../runtimes/alibi-explain/README.md
:relative-docs: ../../docs/
```
22 changes: 12 additions & 10 deletions docs/runtimes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,17 @@ class in your `model-settings.json` file.

## Included Inference Runtimes

| Framework | Package Name | Implementation Class | Example | Documentation |
| ------------ | ----------------------- | ------------------------------------------ | ---------------------------------------------------------- | ---------------------------------------------------------------- |
| Scikit-Learn | `mlserver-sklearn` | `mlserver_sklearn.SKLearnModel` | [Scikit-Learn example](../examples/sklearn/README.md) | [MLServer SKLearn](./sklearn) |
| XGBoost | `mlserver-xgboost` | `mlserver_xgboost.XGBoostModel` | [XGBoost example](../examples/xgboost/README.md) | [MLServer XGBoost](./xgboost) |
| HuggingFace | `mlserver-huggingface` | `mlserver_huggingface.HuggingFaceRuntime` | [HuggingFace example](../examples/huggingface/README.md) | [MLServer HuggingFace](./huggingface) |
| Spark MLlib | `mlserver-mllib` | `mlserver_mllib.MLlibModel` | Coming Soon | [MLServer MLlib](./mllib) |
| LightGBM | `mlserver-lightgbm` | `mlserver_lightgbm.LightGBMModel` | [LightGBM example](../examples/lightgbm/README.md) | [MLServer LightGBM](./lightgbm) |
| Tempo | `tempo` | `tempo.mlserver.InferenceRuntime` | [Tempo example](../examples/tempo/README.md) | [`github.com/SeldonIO/tempo`](https://github.com/SeldonIO/tempo) |
| MLflow | `mlserver-mlflow` | `mlserver_mlflow.MLflowRuntime` | [MLflow example](../examples/mlflow/README.md) | [MLServer MLflow](./mlflow) |
| Alibi-Detect | `mlserver-alibi-detect` | `mlserver_alibi_detect.AlibiDetectRuntime` | [Alibi-detect example](../examples/alibi-detect/README.md) | [MLServer Alibi-Detect](./alibi-detect) |
| Framework | Package Name | Implementation Class | Example | Documentation |
| ------------- | ------------------------ | -------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
| Scikit-Learn | `mlserver-sklearn` | `mlserver_sklearn.SKLearnModel` | [Scikit-Learn example](../examples/sklearn/README.md) | [MLServer SKLearn](./sklearn) |
| XGBoost | `mlserver-xgboost` | `mlserver_xgboost.XGBoostModel` | [XGBoost example](../examples/xgboost/README.md) | [MLServer XGBoost](./xgboost) |
| HuggingFace | `mlserver-huggingface` | `mlserver_huggingface.HuggingFaceRuntime` | [HuggingFace example](../examples/huggingface/README.md) | [MLServer HuggingFace](./huggingface) |
| Spark MLlib | `mlserver-mllib` | `mlserver_mllib.MLlibModel` | Coming Soon | [MLServer MLlib](./mllib) |
| LightGBM | `mlserver-lightgbm` | `mlserver_lightgbm.LightGBMModel` | [LightGBM example](../examples/lightgbm/README.md) | [MLServer LightGBM](./lightgbm) |
| Tempo | `tempo` | `tempo.mlserver.InferenceRuntime` | [Tempo example](../examples/tempo/README.md) | [`github.com/SeldonIO/tempo`](https://github.com/SeldonIO/tempo) |
| MLflow | `mlserver-mlflow` | `mlserver_mlflow.MLflowRuntime` | [MLflow example](../examples/mlflow/README.md) | [MLServer MLflow](./mlflow) |
| Alibi-Detect | `mlserver-alibi-detect` | `mlserver_alibi_detect.AlibiDetectRuntime` | [Alibi-detect example](../examples/alibi-detect/README.md) | [MLServer Alibi-Detect](./alibi-detect) |
| Alibi-Explain | `mlserver-alibi-explain` | `mlserver_alibi_explain.AlibiExplainRuntime` | Coming Soon | [MLServer Alibi-Explain](./alibi-explain) |

```{toctree}
:hidden:
Expand All @@ -44,6 +45,7 @@ Tempo <https://tempo.readthedocs.io>
Spark MLlib <./mllib>
LightGBM <./lightgbm>
Alibi-Detect <./alibi-detect>
Alibi-Explain <./alibi-explain>
HuggingFace <./huggingface>
Custom <./custom>
```
14 changes: 1 addition & 13 deletions runtimes/alibi-explain/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Alibi-Explain runtime for MLServer

This package provides a MLServer runtime compatible with Alibi-Detect.
This package provides a MLServer runtime compatible with Alibi-Explain.

## Usage

Expand All @@ -9,15 +9,3 @@ You can install the runtime, alongside `mlserver`, as:
```bash
pip install mlserver mlserver-alibi-explain
```

For further information on how to use MLServer with Alibi-Explain, you can check
out this [worked out example](../../docs/examples/alibi-explain/README.md).

## Content Types

If no [content type](../../docs/user-guide/content-type) is present on the
request or metadata, the Alibi-Explain 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).