Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationMetric

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

EvaluationMetric is a resource that represents a reusable metric configuration.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1EvaluationMetric

Returns a new instance of GoogleCloudAiplatformV1EvaluationMetric.



10727
10728
10729
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10727

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time when the EvaluationMetric was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


10683
10684
10685
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10683

def create_time
  @create_time
end

#description ⇒ String

Optional. A description of the EvaluationMetric. Corresponds to the JSON property description

Returns:

  • (String) 


10688
10689
10690
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10688

def description
  @description
end

#display_name ⇒ String

Required. The user-friendly display name for the EvaluationMetric. Corresponds to the JSON property displayName

Returns:

  • (String) 


10693
10694
10695
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10693

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



10699
10700
10701
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10699

def encryption_spec
  @encryption_spec
end

#gcs_uri ⇒ String

Optional. The Google Cloud Storage URI that stores the metric specification.. Corresponds to the JSON property gcsUri

Returns:

  • (String) 


10704
10705
10706
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10704

def gcs_uri
  @gcs_uri
end

#labels ⇒ Hash<String,String>

Optional. Labels for the evaluation metric. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


10709
10710
10711
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10709

def labels
  @labels
end

#metric ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Metric

The metric used for running evaluations. Corresponds to the JSON property metric

Returns:



10714
10715
10716
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10714

def metric
  @metric
end

#name ⇒ String

Identifier. The resource name of the EvaluationMetric. Format: projects/ project/locations/location/evaluationMetrics/evaluation_metric` Corresponds to the JSON propertyname`

Returns:

  • (String) 


10720
10721
10722
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10720

def name
  @name
end

#update_time ⇒ String

Output only. The time when the EvaluationMetric was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


10725
10726
10727
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10725

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10732

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
  @labels = args[:labels] if args.key?(:labels)
  @metric = args[:metric] if args.key?(:metric)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
end