Class: Google::Cloud::DataLabeling::V1beta1::EvaluationJobConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb

Overview

Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob.

Defined Under Namespace

Classes: BigqueryImportKeysEntry

Instance Attribute Summary collapse

Instance Attribute Details

#bigquery_import_keys ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

You can provide the following entries in this field:

  • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
  • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
  • label_json_key: the label key for prediction output. Required.
  • label_score_json_key: the score key for prediction output. Required.
  • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

Learn how to configure prediction keys.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON.

    You can provide the following entries in this field:

    • data_json_key: the data key for prediction input. You must provide either this key or reference_json_key.
    • reference_json_key: the data reference key for prediction input. You must provide either this key or data_json_key.
    • label_json_key: the label key for prediction output. Required.
    • label_score_json_key: the score key for prediction output. Required.
    • bounding_box_json_key: the bounding box key for prediction output. Required if your model version perform image object detection.

    Learn how to configure prediction keys.



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#bounding_poly_config ⇒ ::Google::Cloud::DataLabeling::V1beta1::BoundingPolyConfig

Returns Specify this field if your model version performs image object detection (bounding box detection).

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#evaluation_config ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationConfig

Returns Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.

Returns:

  • (::Google::Cloud::DataLabeling::V1beta1::EvaluationConfig) —

    Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the boundingBoxEvaluationOptions field within this configuration. Otherwise, provide an empty object for this configuration.



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#evaluation_job_alert_config ⇒ ::Google::Cloud::DataLabeling::V1beta1::EvaluationJobAlertConfig

Returns Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#example_count ⇒ ::Integer

Returns Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides example_sample_percentage: even if the service has not sampled enough predictions to fulfill example_sample_perecentage during an interval, it stops sampling predictions when it meets this limit.

Returns:

  • (::Integer) —

    Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides example_sample_percentage: even if the service has not sampled enough predictions to fulfill example_sample_perecentage during an interval, it stops sampling predictions when it meets this limit.



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#example_sample_percentage ⇒ ::Float

Returns Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.

Returns:

  • (::Float) —

    Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#human_annotation_config ⇒ ::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig

Returns Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.

Returns:

  • (::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig) —

    Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to true for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field.

    Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the instruction field within this configuration.



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#image_classification_config ⇒ ::Google::Cloud::DataLabeling::V1beta1::ImageClassificationConfig

Returns Specify this field if your model version performs image classification or general classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#input_config ⇒ ::Google::Cloud::DataLabeling::V1beta1::InputConfig

Returns Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

  • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
  • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
  • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
  • You must specify bigquerySource (not gcsSource).

Returns:

  • (::Google::Cloud::DataLabeling::V1beta1::InputConfig) —

    Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields:

    • dataType must be one of IMAGE, TEXT, or GENERAL_DATA.
    • annotationType must be one of IMAGE_CLASSIFICATION_ANNOTATION, TEXT_CLASSIFICATION_ANNOTATION, GENERAL_CLASSIFICATION_ANNOTATION, or IMAGE_BOUNDING_BOX_ANNOTATION (image object detection).
    • If your machine learning model performs classification, you must specify classificationMetadata.isMultiLabel.
    • You must specify bigquerySource (not gcsSource).


236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#text_classification_config ⇒ ::Google::Cloud::DataLabeling::V1beta1::TextClassificationConfig

Returns Specify this field if your model version performs text classification.

annotationSpecSet in this configuration must match EvaluationJob.annotationSpecSet. allowMultiLabel in this configuration must match classificationMetadata.isMultiLabel in input_config.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb', line 236

class EvaluationJobConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BigqueryImportKeysEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end