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
Namespace
Google \ Cloud \ DataLabeling \ V1beta1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
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 |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfig
Output only. Options used in the evaluation job that created this evaluation.
| Returns | |
|---|---|
| Type | Description |
EvaluationConfig|null |
|
hasConfig
clearConfig
setConfig
Output only. Options used in the evaluation job that created this evaluation.
| Parameter | |
|---|---|
| Name | Description |
var |
EvaluationConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEvaluationJobRunTime
Output only. Timestamp for when the evaluation job that created this evaluation ran.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEvaluationJobRunTime
clearEvaluationJobRunTime
setEvaluationJobRunTime
Output only. Timestamp for when the evaluation job that created this evaluation ran.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp for when this evaluation was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp for when this evaluation was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEvaluationMetrics
Output only. Metrics comparing predictions to ground truth labels.
| Returns | |
|---|---|
| Type | Description |
EvaluationMetrics|null |
|
hasEvaluationMetrics
clearEvaluationMetrics
setEvaluationMetrics
Output only. Metrics comparing predictions to ground truth labels.
| Parameter | |
|---|---|
| Name | Description |
var |
EvaluationMetrics
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
int |
Enum of type AnnotationType. |
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 | |
|---|---|
| Name | Description |
var |
int
Enum of type AnnotationType. |
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|