Artifact references

Deeploy uses configuration in JSON notation to specify details for model, explainer and transformer artifacts. This can be either be specified in a 'reference.json' file when using a linked Git repository, or in the Deeploy UI when not using a linked Git repository. This article includes examples for various configurations.

Model reference schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "reference": {
      "type": "object",
      "properties": {
        "azureML": {
          "type": "object",
          "properties": {
            "image": {
              "type": "string"
            },
            "uri": {
              "type": "string"
            },
            "port": {
              "type": "integer"
            },
            "readinessPath": {
              "type": "string"
            },
            "livenessPath": {
              "type": "string"
            },
            "model": {
              "type": ["string", "null"]
            },
            "version": {
              "type": ["string", "null"]
            }
          },
        },
        "docker": {
          "type": "object",
          "properties": {
            "image": {
              "type": "string"
            },
            "uri": {
              "type": "string"
            },
            "port": {
              "type": ["integer", "null"]
            }
          },
        },
        "blob": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string"
            },
            "region": {
              "type": ["string", "null"]
            }
          },
        },
        "huggingface": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string"
            }
          },
        },
        "mlflow": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string"
            },
            "version": {
              "type": ["string", "null"]
            },
            "stage": {
              "type": ["string", "null"]
            },
            "alias": {
              "type": ["string", "null"]
            },
            "blob": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                }
              },
            }
          },
        },
        "databricks": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string"
            },
            "alias": {
              "type": ["string", "null"]
            },
            "version": {
              "type": ["string", "null"]
            }
          },
        }
      },
    }
  },
}

Explainer reference schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "reference": {
      "type": "object",
      "properties": {
        "azureML": {
          "type": "object",
          "properties": {
            "image": {
              "type": "string"
            },
            "uri": {
              "type": "string"
            },
            "port": {
              "type": "integer"
            },
            "readinessPath": {
              "type": "string"
            },
            "livenessPath": {
              "type": "string"
            },
            "model": {
              "type": ["string", "null"]
            },
            "version": {
              "type": ["string", "null"]
            }
          },
        },
        "docker": {
          "type": "object",
          "properties": {
            "image": {
              "type": "string"
            },
            "uri": {
              "type": "string"
            },
            "port": {
              "type": ["integer", "null"]
            }
          },
        },
        "blob": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string"
            },
            "region": {
              "type": ["string", "null"]
            }
          },
        },
        "mlflow": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string"
            },
            "version": {
              "type": ["string", "null"]
            },
            "stage": {
              "type": ["string", "null"]
            },
            "alias": {
              "type": ["string", "null"]
            },
            "blob": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string"
                }
              },
            }
          },
        },
        "databricks": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string"
            },
            "alias": {
              "type": ["string", "null"]
            },
            "version": {
              "type": ["string", "null"]
            }
          },
        }
      },
    }
  },
}

Explainer reference schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "reference": {
      "type": "object",
      "properties": {
        "docker": {
          "type": "object",
          "properties": {
            "image": {
              "type": "string"
            },
            "uri": {
              "type": "string"
            },
            "port": {
              "type": ["integer", "null"]
            }
          },
        },
        "blob": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string"
            },
            "region": {
              "type": ["string", "null"]
            }
          },
        },
      },
    }
  },
}

Examples

An example of the reference.json file, as seen in the Scikit-Learn census example:

{
    "reference": {
        "blob": {
            "url": "s3://deeploy-examples/sklearn/census/20220801171658/model"
        }
    }
}

When specifying an s3 bucket in a different region (Deeploy Cloud only) than eu-central-1 you need to specify it in the blob section, as illustrated in this example:

# this reference is used in example repository: 
# https://gitlab.com/deeploy-ml/sample-models/example-pytorch-mnist
{  
 "reference": {
     "blob": {
         "url": "s3://deeploy-examples/pytorch/mnist/model",
         "region": "eu-west-1"
     }
  }
}

An example of the reference.json file that refers to a Docker image, as seen in the Custom Image Hello World Example:

# this reference is used in example repository:
# https://gitlab.com/deeploy-ml/sample-models/example-custom-image-hello-world/
{
    "reference": {
        "docker": {
            "image": "deeployml/example-custom-image-hello-world:0.3.0",
            "port": 8080
        }
    }
}

Note

For model and explainer reference.json both docker and blob configurations can be specified.

{
    "reference": {
        "blob": {
            "url": "s3://path-to-blob"
        },
        "docker": {
            "image": "image-name",
            "port": port-number
        }
    }
}

An example of the reference.json that uses the Databricks Unity Catalog integration in combination with a model alias:

{
    "reference": {
        "databricks": {
            "model": "deeploy.default.model",
            "alias": "Champion"
        }
    }
}

An example of the reference.json that uses the Databricks Unity Catalog integration in combination with a model version:

{
    "reference": {
        "databricks": {
            "model": "deeploy.default.model",
            "version": "5"
        }
    }
}