/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

Shows the final value for the objective metric for a training job that was * launched by a hyperparameter tuning job. You define the objective metric in the * HyperParameterTuningJobObjective parameter of * HyperParameterTuningJobConfig.

See Also:

AWS * API Reference

*/ class AWS_SAGEMAKER_API FinalHyperParameterTuningJobObjectiveMetric { public: FinalHyperParameterTuningJobObjectiveMetric(); FinalHyperParameterTuningJobObjectiveMetric(Aws::Utils::Json::JsonView jsonValue); FinalHyperParameterTuningJobObjectiveMetric& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

Whether to minimize or maximize the objective metric. Valid values are * Minimize and Maximize.

*/ inline const HyperParameterTuningJobObjectiveType& GetType() const{ return m_type; } /** *

Whether to minimize or maximize the objective metric. Valid values are * Minimize and Maximize.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

Whether to minimize or maximize the objective metric. Valid values are * Minimize and Maximize.

*/ inline void SetType(const HyperParameterTuningJobObjectiveType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

Whether to minimize or maximize the objective metric. Valid values are * Minimize and Maximize.

*/ inline void SetType(HyperParameterTuningJobObjectiveType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

Whether to minimize or maximize the objective metric. Valid values are * Minimize and Maximize.

*/ inline FinalHyperParameterTuningJobObjectiveMetric& WithType(const HyperParameterTuningJobObjectiveType& value) { SetType(value); return *this;} /** *

Whether to minimize or maximize the objective metric. Valid values are * Minimize and Maximize.

*/ inline FinalHyperParameterTuningJobObjectiveMetric& WithType(HyperParameterTuningJobObjectiveType&& value) { SetType(std::move(value)); return *this;} /** *

The name of the objective metric.

*/ inline const Aws::String& GetMetricName() const{ return m_metricName; } /** *

The name of the objective metric.

*/ inline bool MetricNameHasBeenSet() const { return m_metricNameHasBeenSet; } /** *

The name of the objective metric.

*/ inline void SetMetricName(const Aws::String& value) { m_metricNameHasBeenSet = true; m_metricName = value; } /** *

The name of the objective metric.

*/ inline void SetMetricName(Aws::String&& value) { m_metricNameHasBeenSet = true; m_metricName = std::move(value); } /** *

The name of the objective metric.

*/ inline void SetMetricName(const char* value) { m_metricNameHasBeenSet = true; m_metricName.assign(value); } /** *

The name of the objective metric.

*/ inline FinalHyperParameterTuningJobObjectiveMetric& WithMetricName(const Aws::String& value) { SetMetricName(value); return *this;} /** *

The name of the objective metric.

*/ inline FinalHyperParameterTuningJobObjectiveMetric& WithMetricName(Aws::String&& value) { SetMetricName(std::move(value)); return *this;} /** *

The name of the objective metric.

*/ inline FinalHyperParameterTuningJobObjectiveMetric& WithMetricName(const char* value) { SetMetricName(value); return *this;} /** *

The value of the objective metric.

*/ inline double GetValue() const{ return m_value; } /** *

The value of the objective metric.

*/ inline bool ValueHasBeenSet() const { return m_valueHasBeenSet; } /** *

The value of the objective metric.

*/ inline void SetValue(double value) { m_valueHasBeenSet = true; m_value = value; } /** *

The value of the objective metric.

*/ inline FinalHyperParameterTuningJobObjectiveMetric& WithValue(double value) { SetValue(value); return *this;} private: HyperParameterTuningJobObjectiveType m_type; bool m_typeHasBeenSet; Aws::String m_metricName; bool m_metricNameHasBeenSet; double m_value; bool m_valueHasBeenSet; }; } // namespace Model } // namespace SageMaker } // namespace Aws