Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluation

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

A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1ModelEvaluation

Returns a new instance of GoogleCloudAiplatformV1ModelEvaluation.



10636
10637
10638
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10636

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

Instance Attribute Details

#annotation_schema_uri ⇒ String

Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions, EvaluatedDataItemView.ground_truths, EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. The schema is defined as an OpenAPI 3.0.2 Schema Object. This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation. Corresponds to the JSON property annotationSchemaUri

Returns:

  • (String) 


10570
10571
10572
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10570

def annotation_schema_uri
  @annotation_schema_uri
end

#create_time ⇒ String

Output only. Timestamp when this ModelEvaluation was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


10575
10576
10577
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10575

def create_time
  @create_time
end

#data_item_schema_uri ⇒ String

Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and EvaluatedAnnotation. data_item_payload. The schema is defined as an OpenAPI 3.0.2 Schema Object. This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation. Corresponds to the JSON property dataItemSchemaUri

Returns:

  • (String) 


10585
10586
10587
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10585

def data_item_schema_uri
  @data_item_schema_uri
end

#display_name ⇒ String

The display name of the ModelEvaluation. Corresponds to the JSON property displayName

Returns:

  • (String) 


10590
10591
10592
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10590

def display_name
  @display_name
end

#explanation_specs ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec>

Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data. Corresponds to the JSON property explanationSpecs

Returns:



10596
10597
10598
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10596

def explanation_specs
  @explanation_specs
end

#metadata ⇒ Object

The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of " pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path". Corresponds to the JSON property metadata

Returns:

  • (Object) 


10603
10604
10605
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10603

def metadata
  @metadata
end

#metrics ⇒ Object

Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri Corresponds to the JSON property metrics

Returns:

  • (Object) 


10609
10610
10611
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10609

def metrics
  @metrics
end

#metrics_schema_uri ⇒ String

Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object. Corresponds to the JSON property metricsSchemaUri

Returns:

  • (String) 


10617
10618
10619
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10617

def metrics_schema_uri
  @metrics_schema_uri
end

#model_explanation ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelExplanation

Aggregated explanation metrics for a Model over a set of instances. Corresponds to the JSON property modelExplanation

Returns:



10622
10623
10624
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10622

def model_explanation
  @model_explanation
end

#name ⇒ String

Output only. The resource name of the ModelEvaluation. Corresponds to the JSON property name

Returns:

  • (String) 


10627
10628
10629
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10627

def name
  @name
end

#slice_dimensions ⇒ Array<String>

All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension =. Corresponds to the JSON property sliceDimensions

Returns:

  • (Array<String>) 


10634
10635
10636
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10634

def slice_dimensions
  @slice_dimensions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10641

def update!(**args)
  @annotation_schema_uri = args[:annotation_schema_uri] if args.key?(:annotation_schema_uri)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_item_schema_uri = args[:data_item_schema_uri] if args.key?(:data_item_schema_uri)
  @display_name = args[:display_name] if args.key?(:display_name)
  @explanation_specs = args[:explanation_specs] if args.key?(:explanation_specs)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metrics = args[:metrics] if args.key?(:metrics)
  @metrics_schema_uri = args[:metrics_schema_uri] if args.key?(:metrics_schema_uri)
  @model_explanation = args[:model_explanation] if args.key?(:model_explanation)
  @name = args[:name] if args.key?(:name)
  @slice_dimensions = args[:slice_dimensions] if args.key?(:slice_dimensions)
end