StartMlModelTrainingJobRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class StartMlModelTrainingJobRequest
extends NeptunedataRequest
implements ToCopyableBuilder<StartMlModelTrainingJobRequest.Builder,StartMlModelTrainingJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartMlModelTrainingJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartMlModelTrainingJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`baseProcessingInstanceType()` The type of ML instance used in preparing and managing training of ML models.
`static StartMlModelTrainingJobRequest.Builder`	`builder()`
`CustomModelTrainingParameters`	`customModelTrainingParameters()` The configuration for custom model training.
`String`	`dataProcessingJobId()` The job ID of the completed data-processing job that has created the data that the training will work with.
`Boolean`	`enableManagedSpotTraining()` Optimizes the cost of training machine-learning models by using Amazon Elastic Compute Cloud spot instances.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` For responses, this returns true if the service returned a value for the SecurityGroupIds property.
`boolean`	`hasSubnets()` For responses, this returns true if the service returned a value for the Subnets property.
`String`	`id()` A unique identifier for the new job.
`Integer`	`maxHPONumberOfTrainingJobs()` Maximum total number of training jobs to start for the hyperparameter tuning job.
`Integer`	`maxHPOParallelTrainingJobs()` Maximum number of parallel training jobs to start for the hyperparameter tuning job.
`String`	`neptuneIamRoleArn()` The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources.
`String`	`previousModelTrainingJobId()` The job ID of a completed model-training job that you want to update incrementally based on updated data.
`String`	`s3OutputEncryptionKMSKey()` The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job.
`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.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The VPC security group IDs.
`static Class<? extends StartMlModelTrainingJobRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subnets()` The IDs of the subnets in the Neptune VPC.
`StartMlModelTrainingJobRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`trainingInstanceType()` The type of ML instance used for model training.
`Integer`	`trainingInstanceVolumeSizeInGB()` The disk volume size of the training instance.
`Integer`	`trainingTimeOutInSeconds()` Timeout in seconds for the training job.
`String`	`trainModelS3Location()` The location in Amazon S3 where the model artifacts are to be stored.
`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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartMlModelTrainingJobRequest.Builder,StartMlModelTrainingJobRequest>
    
    Specified by:
    
    toBuilder in class NeptunedataRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartMlModelTrainingJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

previousModelTrainingJobId

dataProcessingJobId

trainModelS3Location

sagemakerIamRoleArn

neptuneIamRoleArn

baseProcessingInstanceType

trainingInstanceType

trainingInstanceVolumeSizeInGB

trainingTimeOutInSeconds

maxHPONumberOfTrainingJobs

maxHPOParallelTrainingJobs

hasSubnets

subnets

hasSecurityGroupIds

securityGroupIds

volumeEncryptionKMSKey

s3OutputEncryptionKMSKey

enableManagedSpotTraining

customModelTrainingParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields