addons/models/4000-MachineLearning/4010-ml_model.json

{
  "enumDefs": [
    {
      "name":        "ml_model_deployment_status",
      "typeVersion": "1.0",
      "description": "The deployment status of a ML model build",
      "elementDefs": [
        { "value": "unknown",   "ordinal": 0 },
        { "value": "deploying", "ordinal": 1 },
        { "value": "deployed",  "ordinal": 2 },
        { "value": "stopping",  "ordinal": 3 },
        { "value": "stopped",   "ordinal": 4 }
      ]
    }
  ],
  "entityDefs": [
    {
      "name":        "ml_project",
      "superTypes":  [ "DataSet" ],
      "serviceType": "ml",
      "typeVersion": "1.0",
      "description": "Represent a ML Project that contains source code and related resources",
      "attributeDefs": [
        { "name": "metadata",     "typeName": "map<string,string>", "cardinality": "SINGLE", "isIndexable": false, "isOptional": true, "isUnique": false, "description": "Contains key-value pairs that provide project metadata", "options": { "isAppendOnPartialUpdate": "true" } },
        { "name": "createTime",   "typeName": "date",               "cardinality": "SINGLE", "isIndexable": true,  "isOptional": true, "isUnique": false },
        { "name": "modifiedTime", "typeName": "date",               "cardinality": "SINGLE", "isIndexable": true,  "isOptional": true, "isUnique": false }
      ]
    },
    {
      "name":        "ml_model_build",
      "superTypes":  [ "DataSet" ],
      "serviceType": "ml",
      "typeVersion": "1.0",
      "description": "An immutable container image built from a ML project and its training data",
      "attributeDefs": [
        { "name": "version",              "typeName": "int",                "cardinality": "SINGLE", "isIndexable": true,  "isOptional": false, "isUnique": false },
        { "name": "metadata",             "typeName": "map<string,string>", "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false, "description": "Contains key-value pairs that provide metadata", "options": { "isAppendOnPartialUpdate": "true" } },
        { "name": "defaultCpuMillicores", "typeName": "int",                "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false },
        { "name": "defaultMemoryMb",      "typeName": "int",                "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false },
        { "name": "defaultGpus",          "typeName": "int",                "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false },
        { "name": "imageTag",             "typeName": "string",             "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false, "valuesMinCount": 0, "valuesMaxCount": 1, "description": "Include URL to get the container image of this model build", "includeInNotification": false },
        { "name": "imageHash",            "typeName": "string",             "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false, "valuesMinCount": 0, "valuesMaxCount": 1, "description": "Image signature. Combined with imageTag to uniquely identify a model build", "includeInNotification": false },
        { "name": "exampleRequest",       "typeName": "string",             "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false, "valuesMinCount": 0, "valuesMaxCount": 1, "description": "request example to the model as a JSON string", "includeInNotification": false },
        { "name": "exampleResponse",      "typeName": "string",             "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false, "valuesMinCount": 0, "valuesMaxCount": 1, "description": "response example from the model as a JSON string", "includeInNotification": false },
        { "name": "createTime",           "typeName": "date",               "cardinality": "SINGLE", "isIndexable": true,  "isOptional": true,  "isUnique": false }
      ]
    },
    {
      "name":        "ml_model_deployment",
      "superTypes":  [ "DataSet" ],
      "serviceType": "ml",
      "typeVersion": "1.0",
      "description": "A deployed instance of a model build",
      "attributeDefs": [
        { "name": "createTime",       "typeName": "date",                       "cardinality": "SINGLE", "isIndexable": false, "isOptional": false, "isUnique": false },
        { "name": "deployedTime",     "typeName": "date",                       "cardinality": "SINGLE", "isIndexable": false, "isOptional": false, "isUnique": false },
        { "name": "metadata",         "typeName": "map<string,string>",         "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false, "description": "Contains key-value pairs that provide metadata", "options": { "isAppendOnPartialUpdate": "true" } },
        { "name": "modelEndpointURL", "typeName": "string",                     "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false, "valuesMinCount": 0, "valuesMaxCount": 1, "description": "The URL to receive request and send back prediction", "includeInNotification": false },
        { "name": "status",           "typeName": "ml_model_deployment_status", "cardinality": "SINGLE", "isIndexable": true,  "isOptional": false, "isUnique": false },
        { "name": "cpuMillicores",    "typeName": "int",                        "cardinality": "SINGLE", "isIndexable": false, "isOptional": false, "isUnique": false },
        { "name": "memoryMb",         "typeName": "int",                        "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false },
        { "name": "gpus",             "typeName": "int",                        "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false },
        { "name": "replicas",         "typeName": "int",                        "cardinality": "SINGLE", "isIndexable": false, "isOptional": true,  "isUnique": false }
      ]
    },
    {
      "name":        "ml_project_create_process",
      "superTypes":  [ "Process" ],
      "serviceType": "ml",
      "typeVersion": "1.0",
      "description": "process that creates a ML project",
      "attributeDefs": [
        { "name": "userName", "typeName": "string", "cardinality": "SINGLE", "isIndexable": true, "isOptional": false, "isUnique": false }
      ]
    },
    {
      "name":        "ml_model_train_build_process",
      "superTypes":  [ "Process" ],
      "serviceType": "ml",
      "typeVersion": "1.0",
      "description": "process that trains a model and builds an immutable model build",
      "attributeDefs": [
        { "name": "userName", "typeName": "string", "cardinality": "SINGLE", "isIndexable": true, "isOptional": false, "isUnique": false }
      ]
    },
    {
      "name":        "ml_model_deploy_process",
      "superTypes":  [ "Process" ],
      "serviceType": "ml",
      "typeVersion": "1.0",
      "description": "process that deploys a model build and creates replicated instances",
      "attributeDefs": [
        { "name": "userName", "typeName": "string", "cardinality": "SINGLE", "isIndexable": true, "isOptional": false, "isUnique": false }
      ]
    }
  ],
  "relationshipDefs": [
    {
      "name":                 "ml_project_model_build",
      "serviceType":          "ml",
      "typeVersion":          "1.0",
      "relationshipCategory": "COMPOSITION",
      "relationshipLabel":    "__ml_project.builds",
      "propagateTags":        "NONE",
      "endDef1": { "type": "ml_project",     "name": "builds",  "isContainer": true,  "cardinality": "SET" },
      "endDef2": { "type": "ml_model_build", "name": "project", "isContainer": false, "cardinality": "SINGLE" }
    },
    {
      "name":                 "ml_build_deployment",
      "serviceType":          "ml",
      "typeVersion":          "1.0",
      "relationshipCategory": "COMPOSITION",
      "relationshipLabel":    "__ml_build.deployments",
      "propagateTags":        "NONE",
      "endDef1": { "type": "ml_model_build",      "name": "deployments", "isContainer": true,  "cardinality": "SET" },
      "endDef2": { "type": "ml_model_deployment", "name": "build",       "isContainer": false, "cardinality": "SINGLE" }
    }
  ]
}