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.

Defines the training jobs launched by a hyperparameter tuning job.

Inheritance Hierarchy

System.Object
  Amazon.SageMaker.Model.HyperParameterTrainingJobDefinition

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

Syntax

C#
public class HyperParameterTrainingJobDefinition

The HyperParameterTrainingJobDefinition type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AlgorithmSpecification Amazon.SageMaker.Model.HyperParameterAlgorithmSpecification

Gets and sets the property AlgorithmSpecification.

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

Public Property CheckpointConfig Amazon.SageMaker.Model.CheckpointConfig

Gets and sets the property CheckpointConfig.

Public Property DefinitionName System.String

Gets and sets the property DefinitionName.

The job definition name.

Public Property EnableInterContainerTrafficEncryption System.Boolean

Gets and sets the property EnableInterContainerTrafficEncryption.

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

Public Property EnableManagedSpotTraining System.Boolean

Gets and sets the property EnableManagedSpotTraining.

A Boolean indicating whether managed spot training is enabled (True) or not (False).

Public Property EnableNetworkIsolation System.Boolean

Gets and sets the property EnableNetworkIsolation.

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

Public Property Environment System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Environment.

An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See Define metrics and variables for more information.

The maximum number of items specified for Map Entries refers to the maximum number of environment variables for each TrainingJobDefinition and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.

Public Property HyperParameterRanges Amazon.SageMaker.Model.ParameterRanges

Gets and sets the property HyperParameterRanges.

Public Property HyperParameterTuningResourceConfig Amazon.SageMaker.Model.HyperParameterTuningResourceConfig

Gets and sets the property HyperParameterTuningResourceConfig.

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

Public Property InputDataConfig System.Collections.Generic.List<Amazon.SageMaker.Model.Channel>

Gets and sets the property InputDataConfig.

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

Public Property OutputDataConfig Amazon.SageMaker.Model.OutputDataConfig

Gets and sets the property OutputDataConfig.

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

Public Property ResourceConfig Amazon.SageMaker.Model.ResourceConfig

Gets and sets the property ResourceConfig.

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

Public Property RetryStrategy Amazon.SageMaker.Model.RetryStrategy

Gets and sets the property RetryStrategy.

The number of times to retry the job when the job fails due to an InternalServerError.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

Public Property StaticHyperParameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property StaticHyperParameters.

Specifies the values of hyperparameters that do not change for the tuning job.

Public Property StoppingCondition Amazon.SageMaker.Model.StoppingCondition

Gets and sets the property StoppingCondition.

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

Public Property TuningObjective Amazon.SageMaker.Model.HyperParameterTuningJobObjective

Gets and sets the property TuningObjective.

Public Property VpcConfig Amazon.SageMaker.Model.VpcConfig

Gets and sets the property VpcConfig.

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

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