Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Metric

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

The metric used for running evaluations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Metric

Returns a new instance of GoogleCloudAiplatformV1Metric.



24198
24199
24200
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24198

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregation_metrics ⇒ Array<String>

Optional. The aggregation metrics to use. Corresponds to the JSON property aggregationMetrics

Returns:

  • (Array<String>) 


24143
24144
24145
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24143

def aggregation_metrics
  @aggregation_metrics
end

#bleu_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BleuSpec

Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. Corresponds to the JSON property bleuSpec

Returns:



24149
24150
24151
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24149

def bleu_spec
  @bleu_spec
end

#computation_based_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputationBasedMetricSpec

Specification for a computation based metric. Corresponds to the JSON property computationBasedMetricSpec

Returns:



24154
24155
24156
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24154

def computation_based_metric_spec
  @computation_based_metric_spec
end

#custom_code_execution_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomCodeExecutionSpec

Specificies a metric that is populated by evaluating user-defined Python code. Corresponds to the JSON property customCodeExecutionSpec

Returns:



24159
24160
24161
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24159

def custom_code_execution_spec
  @custom_code_execution_spec
end

#exact_match_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExactMatchSpec

Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. Corresponds to the JSON property exactMatchSpec

Returns:



24165
24166
24167
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24165

def exact_match_spec
  @exact_match_spec
end

#llm_based_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LlmBasedMetricSpec

Specification for an LLM based metric. Corresponds to the JSON property llmBasedMetricSpec

Returns:



24170
24171
24172
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24170

def llm_based_metric_spec
  @llm_based_metric_spec
end

#metadata ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetricMetadata

Metadata about the metric, used for visualization and organization. Corresponds to the JSON property metadata

Returns:



24175
24176
24177
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24175

def metadata
  @metadata
end

#pairwise_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PairwiseMetricSpec

Spec for pairwise metric. Corresponds to the JSON property pairwiseMetricSpec

Returns:



24180
24181
24182
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24180

def pairwise_metric_spec
  @pairwise_metric_spec
end

#pointwise_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PointwiseMetricSpec

Spec for pointwise metric. Corresponds to the JSON property pointwiseMetricSpec

Returns:



24185
24186
24187
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24185

def pointwise_metric_spec
  @pointwise_metric_spec
end

#predefined_metric_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredefinedMetricSpec

The spec for a pre-defined metric. Corresponds to the JSON property predefinedMetricSpec

Returns:



24190
24191
24192
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24190

def predefined_metric_spec
  @predefined_metric_spec
end

#rouge_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RougeSpec

Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. Corresponds to the JSON property rougeSpec

Returns:



24196
24197
24198
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24196

def rouge_spec
  @rouge_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



24203
24204
24205
24206
24207
24208
24209
24210
24211
24212
24213
24214
24215
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24203

def update!(**args)
  @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics)
  @bleu_spec = args[:bleu_spec] if args.key?(:bleu_spec)
  @computation_based_metric_spec = args[:computation_based_metric_spec] if args.key?(:computation_based_metric_spec)
  @custom_code_execution_spec = args[:custom_code_execution_spec] if args.key?(:custom_code_execution_spec)
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
  @metadata = args[:metadata] if args.key?(:metadata)
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
  @pointwise_metric_spec = args[:pointwise_metric_spec] if args.key?(:pointwise_metric_spec)
  @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
  @rouge_spec = args[:rouge_spec] if args.key?(:rouge_spec)
end