Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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) ⇒ GoogleCloudAiplatformV1beta1ModelEvaluation

Returns a new instance of GoogleCloudAiplatformV1beta1ModelEvaluation.



14252
14253
14254
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14252

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

Instance Attribute Details

#bias_configs ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluationBiasConfig

Configuration for bias detection. Corresponds to the JSON property biasConfigs

Returns:



14195
14196
14197
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14195

def bias_configs
  @bias_configs
end

#create_time ⇒ String

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

Returns:

  • (String) 


14200
14201
14202
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14200

def create_time
  @create_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


14205
14206
14207
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14205

def display_name
  @display_name
end

#explanation_specs ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluationModelEvaluationExplanationSpec>

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

Returns:



14211
14212
14213
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14211

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) 


14219
14220
14221
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14219

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) 


14225
14226
14227
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14225

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) 


14233
14234
14235
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14233

def metrics_schema_uri
  @metrics_schema_uri
end

#model_explanation ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelExplanation

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

Returns:



14238
14239
14240
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14238

def model_explanation
  @model_explanation
end

#name ⇒ String

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

Returns:

  • (String) 


14243
14244
14245
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14243

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


14250
14251
14252
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14250

def slice_dimensions
  @slice_dimensions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14257

def update!(**args)
  @bias_configs = args[:bias_configs] if args.key?(:bias_configs)
  @create_time = args[:create_time] if args.key?(:create_time)
  @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