View Source GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1StudySpecMetricSpec (google_api_ai_platform v0.15.0)

Represents a metric to optimize.

Attributes

  • goal (type: String.t, default: nil) - Required. The optimization goal of the metric.
  • metricId (type: String.t, default: nil) - Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.
  • safetyConfig (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig.t, default: nil) - Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1StudySpecMetricSpec{
    goal: String.t() | nil,
    metricId: String.t() | nil,
    safetyConfig:
      GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig.t()
      | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.