kind: defines the type of a resource
name: defines the name of a resource
contract: an object defining the inputs and outputs of a model.
payload: a list of files that should be added to the container.
install-command: a string defining a command that should be executed during the container build.
training-data: a string defining a path to the file that will be uploaded to Hydrosphere and used as a training data reference. It can be either a local file or a URI to an S3 object. At the moment we only support
metadata: an object defining additional user metadata that will be displayed on the Hydrosphere UI.
contractobject must contain the following fields:
inputs: an object, defining all inputs of a model
outputs: an object, defining all outputs of a model
contractobject can contain the following fields:
name: a string defining the signature of the model that should be used to process requests
fieldobject must contain the following fields:
"scalar"or a list of integers, defining the shape of your data. If a shape is defined as a list of integers, it can have
-1value at the very beginning of the list, indicating that this field has an arbitrary number of "entities".
-1cannot be put anywhere aside from the beginning of the list.
type: a string defining the type of data.
fieldobject can contain the following fields:
profile: a string, defining the profile type of your data.
metadataobject can represent any arbitrary information specified by the user. The structure of the object is not strictly defined. The only constraint is that the object must have a key-value structure, where a value can only be of a simple data type (string, number, boolean).
singular: An object, defining a single-model application;
pipeline: A list of objects, defining an application as a pipeline of models.
singularobject represents an application consisting only of one model. The object must contain the following fields:
model: A string, defining a model version. It is expected to be in the form
pipelinerepresents a list of stages, representing models.
stageobject must contain the following fields:
model: A string defining a model version. It is expected to be in the form
stageobject can contain the following fields:
weight: A number defining the weight of the model. All models' weights in a stage must add up to 100.
claims-preprocessing:1model version and the output will be fed into
claims-model. 80% of the traffic will go to the
claims-model:1model version, 20% of the traffic will go to the
container: An object defining settings applied on a container level
deployment: An object defining settings applied on a deployment level
pod: An object defining settings applied on a pod level
hpaobject must contain:
minReplicas: minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
maxReplicas: integer, upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than minReplicas.
cpuUtilization: integer from 1 to 100, target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
env: object with string keys and string values which is used to set environment variables.
replicaCount: integer, number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.