Amazon Neptune · JSON Structure

Data Start Ml Model Training Job Input Structure

StartMLModelTrainingJobInput schema from Neptune

Type: object Properties: 20 Required: 2

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

StartMLModelTrainingJobInput is a JSON Structure definition published by Amazon Neptune, describing 20 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id dataProcessingJobId trainModelS3Location previousModelTrainingJobId sagemakerIamRoleArn neptuneIamRoleArn modelName baseProcessingInstanceType trainingInstanceType trainingInstanceVolumeSizeInGB trainingTimeOutInSeconds maxHPONumberOfTrainingJobs maxHPOParallelTrainingJobs subnets securityGroupIds volumeEncryptionKMSKey s3OutputEncryptionKMSKey enableInterContainerTrafficEncryption enableManagedSpotTraining customModelTrainingParameters

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-structure/data-start-ml-model-training-job-input-structure.json",
  "name": "StartMLModelTrainingJobInput",
  "description": "StartMLModelTrainingJobInput schema from Neptune",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "dataProcessingJobId": {
      "type": "string",
      "description": "Job ID of the completed data processing job."
    },
    "trainModelS3Location": {
      "type": "string",
      "description": "S3 location for model artifacts."
    },
    "previousModelTrainingJobId": {
      "type": "string"
    },
    "sagemakerIamRoleArn": {
      "type": "string"
    },
    "neptuneIamRoleArn": {
      "type": "string"
    },
    "modelName": {
      "type": "string",
      "description": "The model type to use.",
      "enum": [
        "rgcn",
        "transe",
        "distmult",
        "rotate",
        "custom"
      ]
    },
    "baseProcessingInstanceType": {
      "type": "string"
    },
    "trainingInstanceType": {
      "type": "string",
      "default": "ml.p3.2xlarge"
    },
    "trainingInstanceVolumeSizeInGB": {
      "type": "int32"
    },
    "trainingTimeOutInSeconds": {
      "type": "int32",
      "default": 86400
    },
    "maxHPONumberOfTrainingJobs": {
      "type": "int32",
      "default": 2
    },
    "maxHPOParallelTrainingJobs": {
      "type": "int32",
      "default": 2
    },
    "subnets": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "securityGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "volumeEncryptionKMSKey": {
      "type": "string"
    },
    "s3OutputEncryptionKMSKey": {
      "type": "string"
    },
    "enableInterContainerTrafficEncryption": {
      "type": "boolean",
      "default": true
    },
    "enableManagedSpotTraining": {
      "type": "boolean",
      "default": false
    },
    "customModelTrainingParameters": {
      "type": "object",
      "properties": {
        "sourceS3DirectoryPath": {
          "type": "string"
        },
        "trainingEntryPointScript": {
          "type": "string"
        },
        "transformEntryPointScript": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "dataProcessingJobId",
    "trainModelS3Location"
  ]
}