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.

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateHyperParameterTuningJob and EndCreateHyperParameterTuningJob.

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

Syntax

C#
public virtual Task<CreateHyperParameterTuningJobResponse> CreateHyperParameterTuningJobAsync(
         CreateHyperParameterTuningJobRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SageMaker.Model.CreateHyperParameterTuningJobRequest

Container for the necessary parameters to execute the CreateHyperParameterTuningJob service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateHyperParameterTuningJob service method, as returned by SageMaker.

Exceptions

ExceptionCondition
ResourceInUseException Resource being accessed is in use.
ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also