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.



15603
15604
15605
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15603

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) 


15536
15537
15538
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15536

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) 


15541
15542
15543
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15541

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) 


15551
15552
15553
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15551

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) 


15556
15557
15558
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15556

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:



15562
15563
15564
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15562

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", " row_based_metrics_path". Corresponds to the JSON property metadata

Returns:

  • (Object) 


15570
15571
15572
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15570

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) 


15576
15577
15578
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15576

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) 


15584
15585
15586
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15584

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:



15589
15590
15591
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15589

def model_explanation
  @model_explanation
end

#name ⇒ String

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

Returns:

  • (String) 


15594
15595
15596
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15594

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>) 


15601
15602
15603
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15601

def slice_dimensions
  @slice_dimensions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15608

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