Package software.amazon.awscdk.services.personalize

Interface CfnSolution.HpoObjectiveProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSolution.HpoObjectiveProperty.Jsii$Proxy

Enclosing class:

CfnSolution

@Stability(Stable)
public static interface CfnSolution.HpoObjectiveProperty
extends software.amazon.jsii.JsiiSerializable

The metric to optimize during hyperparameter optimization (HPO).

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.personalize.*;
 HpoObjectiveProperty hpoObjectiveProperty = HpoObjectiveProperty.builder()
         .metricName("metricName")
         .metricRegex("metricRegex")
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSolution.HpoObjectiveProperty.Builder	A builder for CfnSolution.HpoObjectiveProperty
static final class	CfnSolution.HpoObjectiveProperty.Jsii$Proxy	An implementation for CfnSolution.HpoObjectiveProperty

Method Summary

Modifier and Type	Method	Description
static CfnSolution.HpoObjectiveProperty.Builder	builder()
default String	getMetricName()	The name of the metric.
default String	getMetricRegex()	A regular expression for finding the metric in the training job logs.
default String	getType()	The type of the metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricName

@Stability(Stable)
@Nullable
default String getMetricName()

The name of the metric.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricname

getMetricRegex

@Stability(Stable)
@Nullable
default String getMetricRegex()

A regular expression for finding the metric in the training job logs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricregex

getType

@Stability(Stable)
@Nullable
default String getType()

The type of the metric.

Valid values are Maximize and Minimize .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-type

builder

@Stability(Stable)
static CfnSolution.HpoObjectiveProperty.Builder builder()

Returns:

a CfnSolution.HpoObjectiveProperty.Builder of CfnSolution.HpoObjectiveProperty