Google Cloud Ai Platform V1 Client - Class MetricSpec (0.13.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class MetricSpec.

Represents a metric to optimize.

Generated from protobuf message google.cloud.aiplatform.v1.StudySpec.MetricSpec

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ metric_id string

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

↳ goal int

Required. The optimization goal of the metric.

↳ safety_config Google\Cloud\AIPlatform\V1\StudySpec\MetricSpec\SafetyMetricConfig

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

getMetricId

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

Returns
TypeDescription
string

setMetricId

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGoal

Required. The optimization goal of the metric.

Returns
TypeDescription
int

setGoal

Required. The optimization goal of the metric.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSafetyConfig

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\StudySpec\MetricSpec\SafetyMetricConfig|null

hasSafetyConfig

clearSafetyConfig

setSafetyConfig

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\StudySpec\MetricSpec\SafetyMetricConfig
Returns
TypeDescription
$this