Package software.amazon.awssdk.services.neptunedata.model

Class StartMlModelTrainingJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.neptunedata.model.NeptunedataRequest
software.amazon.awssdk.services.neptunedata.model.StartMlModelTrainingJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartMlModelTrainingJobRequest.Builder,StartMlModelTrainingJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartMlModelTrainingJobRequest extends NeptunedataRequest implements ToCopyableBuilder<StartMlModelTrainingJobRequest.Builder,StartMlModelTrainingJobRequest>

  • Method Details

    • id

      public final String id()

      A unique identifier for the new job. The default is An autogenerated UUID.

      Returns:
      A unique identifier for the new job. The default is An autogenerated UUID.

    • previousModelTrainingJobId

      public final String previousModelTrainingJobId()

      The job ID of a completed model-training job that you want to update incrementally based on updated data.

      Returns:
      The job ID of a completed model-training job that you want to update incrementally based on updated data.

    • dataProcessingJobId

      public final String dataProcessingJobId()

      The job ID of the completed data-processing job that has created the data that the training will work with.

      Returns:
      The job ID of the completed data-processing job that has created the data that the training will work with.

    • trainModelS3Location

      public final String trainModelS3Location()

      The location in Amazon S3 where the model artifacts are to be stored.

      Returns:
      The location in Amazon S3 where the model artifacts are to be stored.

    • sagemakerIamRoleArn

      public final String sagemakerIamRoleArn()

      The ARN of an IAM role for SageMaker execution.This must be listed in your DB cluster parameter group or an error will occur.

      Returns:
      The ARN of an IAM role for SageMaker execution.This must be listed in your DB cluster parameter group or an error will occur.

    • neptuneIamRoleArn

      public final String neptuneIamRoleArn()

      The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

      Returns:
      The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

    • baseProcessingInstanceType

      public final String baseProcessingInstanceType()

      The type of ML instance used in preparing and managing training of ML models. This is a CPU instance chosen based on memory requirements for processing the training data and model.

      Returns:
      The type of ML instance used in preparing and managing training of ML models. This is a CPU instance chosen based on memory requirements for processing the training data and model.

    • trainingInstanceType

      public final String trainingInstanceType()

      The type of ML instance used for model training. All Neptune ML models support CPU, GPU, and multiGPU training. The default is ml.p3.2xlarge. Choosing the right instance type for training depends on the task type, graph size, and your budget.

      Returns:
      The type of ML instance used for model training. All Neptune ML models support CPU, GPU, and multiGPU training. The default is ml.p3.2xlarge. Choosing the right instance type for training depends on the task type, graph size, and your budget.

    • trainingInstanceVolumeSizeInGB

      public final Integer trainingInstanceVolumeSizeInGB()

      The disk volume size of the training instance. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

      Returns:
      The disk volume size of the training instance. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

    • trainingTimeOutInSeconds

      public final Integer trainingTimeOutInSeconds()

      Timeout in seconds for the training job. The default is 86,400 (1 day).

      Returns:
      Timeout in seconds for the training job. The default is 86,400 (1 day).

    • maxHPONumberOfTrainingJobs

      public final Integer maxHPONumberOfTrainingJobs()

      Maximum total number of training jobs to start for the hyperparameter tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters of the machine learning model. To obtain a model that performs well, use at least 10 jobs (in other words, set maxHPONumberOfTrainingJobs to 10). In general, the more tuning runs, the better the results.

      Returns:
      Maximum total number of training jobs to start for the hyperparameter tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters of the machine learning model. To obtain a model that performs well, use at least 10 jobs (in other words, set maxHPONumberOfTrainingJobs to 10). In general, the more tuning runs, the better the results.

    • maxHPOParallelTrainingJobs

      public final Integer maxHPOParallelTrainingJobs()

      Maximum number of parallel training jobs to start for the hyperparameter tuning job. The default is 2. The number of parallel jobs you can run is limited by the available resources on your training instance.

      Returns:
      Maximum number of parallel training jobs to start for the hyperparameter tuning job. The default is 2. The number of parallel jobs you can run is limited by the available resources on your training instance.

    • hasSubnets

      public final boolean hasSubnets()
      For responses, this returns true if the service returned a value for the Subnets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • subnets

      public final List<String> subnets()

      The IDs of the subnets in the Neptune VPC. The default is None.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnets() method.

      Returns:
      The IDs of the subnets in the Neptune VPC. The default is None.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroupIds

      public final List<String> securityGroupIds()

      The VPC security group IDs. The default is None.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

      Returns:
      The VPC security group IDs. The default is None.

    • volumeEncryptionKMSKey

      public final String volumeEncryptionKMSKey()

      The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

      Returns:
      The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

    • s3OutputEncryptionKMSKey

      public final String s3OutputEncryptionKMSKey()

      The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

      Returns:
      The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

    • enableManagedSpotTraining

      public final Boolean enableManagedSpotTraining()

      Optimizes the cost of training machine-learning models by using Amazon Elastic Compute Cloud spot instances. The default is False.

      Returns:
      Optimizes the cost of training machine-learning models by using Amazon Elastic Compute Cloud spot instances. The default is False.

    • customModelTrainingParameters

      public final CustomModelTrainingParameters customModelTrainingParameters()

      The configuration for custom model training. This is a JSON object.

      Returns:
      The configuration for custom model training. This is a JSON object.

    • toBuilder

      public StartMlModelTrainingJobRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartMlModelTrainingJobRequest.Builder,StartMlModelTrainingJobRequest>
      Specified by:
      toBuilder in class NeptunedataRequest
      Returns:
      a builder for type T

    • builder

      public static StartMlModelTrainingJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartMlModelTrainingJobRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.