Class: Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1Evaluation

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

Overview

Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatalabelingV1beta1Evaluation

Returns a new instance of GoogleCloudDatalabelingV1beta1Evaluation.



1735
1736
1737
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1735

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

Instance Attribute Details

#annotation_type ⇒ String

Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation. Corresponds to the JSON property annotationType

Returns:

  • (String) 


1698
1699
1700
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1698

def annotation_type
  @annotation_type
end

#config ⇒ Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1EvaluationConfig

Configuration details used for calculating evaluation metrics and creating an Evaluation. Corresponds to the JSON property config

Returns:



1704
1705
1706
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1704

def config
  @config
end

#create_time ⇒ String

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

Returns:

  • (String) 


1709
1710
1711
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1709

def create_time
  @create_time
end

#evaluated_item_count ⇒ Fixnum

Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes. Corresponds to the JSON property evaluatedItemCount

Returns:

  • (Fixnum) 


1716
1717
1718
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1716

def evaluated_item_count
  @evaluated_item_count
end

#evaluation_job_run_time ⇒ String

Output only. Timestamp for when the evaluation job that created this evaluation ran. Corresponds to the JSON property evaluationJobRunTime

Returns:

  • (String) 


1722
1723
1724
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1722

def evaluation_job_run_time
  @evaluation_job_run_time
end

#evaluation_metrics ⇒ Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1EvaluationMetrics

Output only. Metrics comparing predictions to ground truth labels. Corresponds to the JSON property evaluationMetrics

Returns:



1727
1728
1729
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1727

def evaluation_metrics
  @evaluation_metrics
end

#name ⇒ String

Output only. Resource name of an evaluation. The name has the following format: "projects/project_id/datasets/dataset_id/evaluations/ evaluation_id' Corresponds to the JSON property name

Returns:

  • (String) 


1733
1734
1735
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1733

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1740

def update!(**args)
  @annotation_type = args[:annotation_type] if args.key?(:annotation_type)
  @config = args[:config] if args.key?(:config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @evaluated_item_count = args[:evaluated_item_count] if args.key?(:evaluated_item_count)
  @evaluation_job_run_time = args[:evaluation_job_run_time] if args.key?(:evaluation_job_run_time)
  @evaluation_metrics = args[:evaluation_metrics] if args.key?(:evaluation_metrics)
  @name = args[:name] if args.key?(:name)
end