Google Cloud Datalabeling V1beta1 Client - Class Evaluation (0.1.14)

Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class Evaluation.

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

Generated from protobuf message google.cloud.datalabeling.v1beta1.Evaluation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Resource name of an evaluation. The name has the following format: "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}'

↳ config Google\Cloud\DataLabeling\V1beta1\EvaluationConfig

Output only. Options used in the evaluation job that created this evaluation.

↳ evaluation_job_run_time Google\Protobuf\Timestamp

Output only. Timestamp for when the evaluation job that created this evaluation ran.

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp for when this evaluation was created.

↳ evaluation_metrics Google\Cloud\DataLabeling\V1beta1\EvaluationMetrics

Output only. Metrics comparing predictions to ground truth labels.

↳ annotation_type int

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.

↳ evaluated_item_count int|string

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.

getName

Output only. Resource name of an evaluation. The name has the following format: "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}'

Returns
TypeDescription
string

setName

Output only. Resource name of an evaluation. The name has the following format: "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}'

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConfig

Output only. Options used in the evaluation job that created this evaluation.

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\EvaluationConfig|null

hasConfig

clearConfig

setConfig

Output only. Options used in the evaluation job that created this evaluation.

Parameter
NameDescription
var Google\Cloud\DataLabeling\V1beta1\EvaluationConfig
Returns
TypeDescription
$this

getEvaluationJobRunTime

Output only. Timestamp for when the evaluation job that created this evaluation ran.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEvaluationJobRunTime

clearEvaluationJobRunTime

setEvaluationJobRunTime

Output only. Timestamp for when the evaluation job that created this evaluation ran.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCreateTime

Output only. Timestamp for when this evaluation was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp for when this evaluation was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEvaluationMetrics

Output only. Metrics comparing predictions to ground truth labels.

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\EvaluationMetrics|null

hasEvaluationMetrics

clearEvaluationMetrics

setEvaluationMetrics

Output only. Metrics comparing predictions to ground truth labels.

Parameter
NameDescription
var Google\Cloud\DataLabeling\V1beta1\EvaluationMetrics
Returns
TypeDescription
$this

getAnnotationType

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.

Returns
TypeDescription
int

setAnnotationType

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEvaluatedItemCount

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.

Returns
TypeDescription
int|string

setEvaluatedItemCount

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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this