AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartMLModelTrainingJob operation. Creates a new Neptune ML model training job. See Model training using the modeltraining command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTrainingJob IAM action in that cluster.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptunedata.AmazonNeptunedataRequest
      Amazon.Neptunedata.Model.StartMLModelTrainingJobRequest

Namespace: Amazon.Neptunedata.Model
Assembly: AWSSDK.Neptunedata.dll
Version: 3.x.y.z

Syntax

C#
public class StartMLModelTrainingJobRequest : AmazonNeptunedataRequest
         IAmazonWebServiceRequest

The StartMLModelTrainingJobRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property BaseProcessingInstanceType System.String

Gets and sets the property 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.

Public Property CustomModelTrainingParameters Amazon.Neptunedata.Model.CustomModelTrainingParameters

Gets and sets the property CustomModelTrainingParameters.

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

Public Property DataProcessingJobId System.String

Gets and sets the property DataProcessingJobId.

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

Public Property EnableManagedSpotTraining System.Boolean

Gets and sets the property EnableManagedSpotTraining.

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

Public Property Id System.String

Gets and sets the property Id.

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

Public Property MaxHPONumberOfTrainingJobs System.Int32

Gets and sets the property 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.

Public Property MaxHPOParallelTrainingJobs System.Int32

Gets and sets the property 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.

Public Property NeptuneIamRoleArn System.String

Gets and sets the property 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.

Public Property PreviousModelTrainingJobId System.String

Gets and sets the property PreviousModelTrainingJobId.

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

Public Property S3OutputEncryptionKMSKey System.String

Gets and sets the property S3OutputEncryptionKMSKey.

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

Public Property SagemakerIamRoleArn System.String

Gets and sets the property 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.

Public Property SecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroupIds.

The VPC security group IDs. The default is None.

Public Property Subnets System.Collections.Generic.List<System.String>

Gets and sets the property Subnets.

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

Public Property TrainingInstanceType System.String

Gets and sets the property 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.

Public Property TrainingInstanceVolumeSizeInGB System.Int32

Gets and sets the property 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.

Public Property TrainingTimeOutInSeconds System.Int32

Gets and sets the property TrainingTimeOutInSeconds.

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

Public Property TrainModelS3Location System.String

Gets and sets the property TrainModelS3Location.

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

Public Property VolumeEncryptionKMSKey System.String

Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5