Class: Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1EvaluationJob

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

Defines an evaluation job that runs periodically to generate Evaluations. Creating an evaluation job is the starting point for using continuous evaluation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatalabelingV1beta1EvaluationJob

Returns a new instance of GoogleCloudDatalabelingV1beta1EvaluationJob.



1852
1853
1854
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1852

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

Instance Attribute Details

#annotation_spec_set ⇒ String

Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: " projects/project_id/annotationSpecSets/annotation_spec_set_id" Corresponds to the JSON property annotationSpecSet

Returns:

  • (String) 


1783
1784
1785
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1783

def annotation_spec_set
  @annotation_spec_set
end

#attempts ⇒ Array<Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1Attempt>

Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array. Corresponds to the JSON property attempts

Returns:



1789
1790
1791
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1789

def attempts
  @attempts
end

#create_time ⇒ String

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

Returns:

  • (String) 


1794
1795
1796
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1794

def create_time
  @create_time
end

#description ⇒ String

Required. Description of the job. The description can be up to 25,000 characters long. Corresponds to the JSON property description

Returns:

  • (String) 


1800
1801
1802
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1800

def description
  @description
end

#evaluation_job_config ⇒ Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1EvaluationJobConfig

Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob. Corresponds to the JSON property evaluationJobConfig

Returns:



1806
1807
1808
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1806

def evaluation_job_config
  @evaluation_job_config
end

#label_missing_ground_truth ⇒ Boolean Also known as: label_missing_ground_truth?

Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to true. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to false . Corresponds to the JSON property labelMissingGroundTruth

Returns:

  • (Boolean) 


1815
1816
1817
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1815

def label_missing_ground_truth
  @label_missing_ground_truth
end

#model_version ⇒ String

Required. The AI Platform Prediction model version to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: "projects/project_id/models/model_name/ versions/version_name" There can only be one evaluation job per model version. Corresponds to the JSON property modelVersion

Returns:

  • (String) 


1826
1827
1828
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1826

def model_version
  @model_version
end

#name ⇒ String

Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: "projects/project_id/evaluationJobs/ evaluation_job_id" Corresponds to the JSON property name

Returns:

  • (String) 


1833
1834
1835
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1833

def name
  @name
end

#schedule ⇒ String

Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in crontab format or in an English-like format. Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day. Corresponds to the JSON property schedule

Returns:

  • (String) 


1845
1846
1847
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1845

def schedule
  @schedule
end

#state ⇒ String

Output only. Describes the current state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


1850
1851
1852
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1850

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1857

def update!(**args)
  @annotation_spec_set = args[:annotation_spec_set] if args.key?(:annotation_spec_set)
  @attempts = args[:attempts] if args.key?(:attempts)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @evaluation_job_config = args[:evaluation_job_config] if args.key?(:evaluation_job_config)
  @label_missing_ground_truth = args[:label_missing_ground_truth] if args.key?(:label_missing_ground_truth)
  @model_version = args[:model_version] if args.key?(:model_version)
  @name = args[:name] if args.key?(:name)
  @schedule = args[:schedule] if args.key?(:schedule)
  @state = args[:state] if args.key?(:state)
end