Supported Versions
This article describes the supported versions and compatibility with supported ML frameworks. For some frameworks, links to example repositories on Gitlab are included. These example repositories can be used to create example deployments on Deeploy.
| Deeploy | 1.29.x - 1.31.x | 1.32.x + |
|---|---|---|
| KServe | 0.9.0 | 0.11.0 |
| Python | 3.7 - 3.9 | 3.8 - 3.11 |
Model Frameworks
The versions described in the following sections are the recommended versions on which the model images have been built. If you deviate from the version, check for potential compatibility issues.
PyTorch
- Example: https://gitlab.com/deeploy-ml/sample-models/example-pytorch-agenet
- Expected pre-trained model artefact: Model Archive
| Pytorch default image | pytorch/torchserve-kfs:0.6.0 | pytorch/torchserve-kfs:0.8.0 |
|---|---|---|
| torch | 1.7.1 | 2.0.0 |
| torchserve | 0.7.0 | 0.8.0 |
| torch-model-archiver | 0.7.0 | 0.8.0 |
Tensorflow
- Example: https://gitlab.com/deeploy-ml/sample-models/imdb
- Expected pre-trained model artefact: SavedModel
| Tensorflow default image | tensorflow/serving:2.6.2 | tensorflow/serving:2.6.2 |
|---|---|---|
| tensorflow | 2.6.2 | 2.6.2 |
XGBoost
- Example: https://gitlab.com/deeploy-ml/sample-models/iris-proba
- Expected pre-trained model artefact: Booster (model.bst)
| XGBoost default image | kserve/xgbserver:v0.9.0 | kserve/xgbserver:v0.11.0 |
|---|---|---|
| xgboost | 1.5.0 | 1.7.5 |
Scikit-learn
- Example: https://gitlab.com/deeploy-ml/sample-models/example-sklearn-census
- Expected pre-trained model artefact: Joblib (model.joblib)
| Scikit-learn default image | kserve/sklearnserver:v0.9.0 | kserve/sklearnserver:v0.11.0 |
|---|---|---|
| scikit-learn | 1.0.1 | 1.3.0 |
| joblib | 1.1.0 | 1.3.1 |
LightGBM
- Example: https://gitlab.com/deeploy-ml/sample-models/example-sklearn-census
- Expected pre-trained model artefact: Booster (model.bst)
| LightGBM default image | kserve/lgbserver:v0.9.0 | kserve/lgbserver:v0.11.0 |
|---|---|---|
| lightgbm | 3.3.2 | 3.3.5 |
Custom model Docker images
| Custom model | image-repo/image-name>:tag | image-repo/image-name:tag |
|---|---|---|
| deeploy-cli | - | 0.1.0 |
| kserve | 0.9.0 | 0.11.0 |
Standard Explainers
Tree Shap
The tree shap explainer can be deployed without any need for training. It can be applied for tree based classification models of the frameworks XGBoost, Scikit-learn, and LightGBM. Explanations are returned for the predicted class.
In case of multiple inputs in single explanation request, the explanation values are returned only for first input.
In LightGBM models where probabilities are returned, the explanation is for class with highest probability.
Trained Explainer Frameworks
The versions described in the following sections are the recommended versions on which the model images have been built. If you deviate from the version, check for potential compatibility issues.
Shap
- Example: https://gitlab.com/deeploy-ml/sample-models/example-sklearn-census
- Expected pre-trained explainer artefact: dill (explainer.dill)
| Shap kernel default image | deeployml/alibi-explainer:v0.9.0-deeploy-1.0.0 | deeployml/alibi-explainer:v0.11.0-deeploy-1.0.0 |
|---|---|---|
| shap | 0.36.0 | 0.42.1 |
| dill | 0.3.3 | 0.3.7 |
Anchors
- Example: https://gitlab.com/deeploy-ml/sample-models/example-sklearn-census
- Expected pre-trained explainer artefact: dill (explainer.dill)
| Anchor tabular, text, image default image | deeployml/alibi-explainer:v0.9.0-deeploy-1.0.0 | deeployml/alibi-explainer:v0.11.0-deeploy-1.0.0 |
|---|---|---|
| alibi | 0.6.4 | 0.9.4 |
| dill | 0.3.3 | 0.3.7 |
MACE
- Expected pre-trained explainer artefact: dill (explainer.dill)
| Anchor tabular, text, image default image | deeployml/alibi-explainer:v0.9.0-deeploy-1.0.0 | deeployml/alibi-explainer:v0.11.0-deeploy-1.0.0 |
|---|---|---|
| omnixai | 1.1.4 | 1.3.1 |
| dill | 0.3.3 | 0.3.7 |
PDP
- Expected pre-trained explainer artefact: dill (explainer.dill)
| Anchor tabular, text, image default image | deeployml/alibi-explainer:v0.9.0-deeploy-1.0.0 | deeployml/alibi-explainer:v0.11.0-deeploy-1.0.0 |
|---|---|---|
| omnixai | 1.1.4 | 1.3.1 |
| dill | 0.3.3 | 0.3.7 |
Custom explainer Docker images
| Custom model | image-repo/image-name>:tag | image-repo/image-name:tag |
|---|---|---|
| deeploy | - | 1.3.0 |
| kserve | 0.9.0 | 0.11.0 |
Transformer Frameworks
Custom transformer Docker images
| Custom docker | image-repo/image-name>:tag | image-repo/image-name:tag |
|---|---|---|
| deeploy | - | 1.3.0 |
| kserve | 0.9.0 | 0.11.0 |