name: the name of the registered model. This name uniquely identifies a collection of model versions, registered within the Hydrosphere platform.
signature: the interface of the registered model. This member describes inputs and outputs of the model, as well as other complementary metadata, such as data profile for each field.
metadata: the metadata of the registered model. 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).
monitoringConfiguration: monitoring configuration to be used for this model.
monitoringConfigurationobject defines a monitoring configuration to be used for the model version. The object must contain the following members:
batchSize: size of the batch to be used for aggregations.
monitoringConfigurationobject can be defined.
signatureobject describes the signature of the model. The signature object must contain the following members:
signatureName: The signature of the model, used to process the request;
inputs: A collection of fields, defining the inputs of the model. Each item in the collection describes a single data entry, its type, shape, and profile. A collection must contain at least one item;
outputs: A collection of fields, defining the outputs of the model. Each item in the collection describes a single data entry, its type, shape, and profile. A collection must contain at least one item.
predictobject can be defined.
outputscollections are collectively called "fields". The field object must contain the following members:
name: Name of the field;
dtype: Data type of the field.
profile: Data profile of the field.
shape: Shape of the field.
fieldobject can be defined.
shapeobject defines the shape of the data that the model is processing. The shape object must contain the following members:
dims: An array of dimensions. A collection may be empty — in that case, the tensor will be interpreted as a scalar value.
shapeobject can be defined.
POSTrequest to the
/api/v2/externalmodelendpoint. The request must include a model definition as primary data.
id: Model version ID, uniquely identifying a registered model version within Hydrosphere platform;
model: An object, representing a model collection, registered in Hydrosphere platform;
modelVersion: Model version number in the model collection;
signature: Contract of the model, similar to the one defined in the request section above;
metadata: Metadata of the model, similar to the one defined in the request section above;
monitoringConfiguration: MonitoringConfiguration of the model, similar to the one defined in the request section above;
created: Timestamp, indicating when the model was registered.
modelobject represents a collection of model versions, registered in the platform. The response
modelobject contains the following fields:
id: ID of the model collection;
name: Name of the model collection.
--model-version: A string indicating the model version to which you want to submit the data. The string should be formatted in the following way
--filename: Path to a filename, that you want to submit.
name: The name of the monitoring metric;
modelVersionId: Unique identifier of the model to which you want to assign a metric;
config: Object, representing a configuration of the metric, which will be applied to the model.
configobject defines a configuration of the monitoring metric that will monitor the model. The model must contain the following members:
modelVersionId: Unique identifier of the model that will monitor requests;
threshold: Threshold value, against which monitoring values will be compared using a comparison operator;
thresholdCmpOperator: Object, representing a comparison operator.
thresholdCmpOperatorobject defines the kind of comparison operator that will be used when comparing a value produced by the metric against the threshold. The object must contain the following members:
kind: Kind of comparison operator.
limit: how many requests to fetch;
offset: which offset to make from the beginning.
_id: ID of the request, generated internally by Hydrosphere;
_hs_request_id: ID of the request, specified by user;
_hs_model_name: Name of the model that processed a request;
_hs_model_incremental_version: Version of the model that processed a request;
_hs_model_version_id: ID of the model version, which processed a request;
_hs_raw_checks: Raw checks calculated by Hydrosphere based on the training data;
_hs_metric_checks: Metrics produced by monitoring models;
_hs_latency: Latency, indicating how much it took to process a request;
_hs_error: Error message that occurred during request processing;
_hs_score: The number of all successful checks divided by the number of all checks;
_hs_overall_score: The amount of all successful metric values (not exceeding a specified threshold), divided by the amount of all metric values;
_hs_timestamp: Timestamp in nanoseconds, when the object was generated;
_hs_year: Year when the object was generated;
_hs_month: Month when the object was generated;
_hs_day: Day when the object was generated;
_hs_<field_name>_score: The number of all successful checks calculated for this specific field divided by the total number of all checks calculated for this specific field;
<field_name>: The value of the field.
_hs_raw_checksobject contains all fields, for which checks have been calculated.
_hs_raw_checks_object can be defined.
checkobject declares the check, that has been calculated for the particular field. The following members will be present in the object.
check: Boolean value indicating, whether the check has been passed;
description: Description of the check that has been calculated;
threshold: Threshold of the check;
value: Value of the field;
metricSpecId: Metric specification ID. For each
checkobject this value will be set to
checkobject can be defined.
_hs_metrics_checksobject contains all fields for which metrics have been calculated.
_hs_metrics_checksobject can be defined.
metricobject declares the metric, that has been calculated for the particular field. The following members will be present in the object.
check: Boolean value indicating, whether the metric has not been fired;
description: Name of the metric that has been calculated;
threshold: Threshold of the metric;
value: Value of the metric;
metricSpecId: Metric specification ID.
metricobject can be defined.