Class: Google::Cloud::AIPlatform::V1::ModelEvaluation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb

Overview

A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.

Defined Under Namespace

Classes: ModelEvaluationExplanationSpec

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_schema_uri ⇒ ::String

Returns Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.predictions][], [EvaluatedDataItemView.ground_truths][], EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. The schema is defined as an OpenAPI 3.0.2 Schema Object.

This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.

Returns:

  • (::String) —

    Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.predictions][], [EvaluatedDataItemView.ground_truths][], EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. The schema is defined as an OpenAPI 3.0.2 Schema Object.

    This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this ModelEvaluation was created.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_item_schema_uri ⇒ ::String

Returns Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.data_item_payload][] and EvaluatedAnnotation.data_item_payload. The schema is defined as an OpenAPI 3.0.2 Schema Object.

This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.

Returns:

  • (::String) —

    Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.data_item_payload][] and EvaluatedAnnotation.data_item_payload. The schema is defined as an OpenAPI 3.0.2 Schema Object.

    This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns The display name of the ModelEvaluation.

Returns:

  • (::String) —

    The display name of the ModelEvaluation.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#explanation_specs ⇒ ::Array<::Google::Cloud::AIPlatform::V1::ModelEvaluation::ModelEvaluationExplanationSpec>

Returns Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata ⇒ ::Google::Protobuf::Value

Returns The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of "pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path", "row_based_metrics_path".

Returns:

  • (::Google::Protobuf::Value) —

    The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of "pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path", "row_based_metrics_path".



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metrics ⇒ ::Google::Protobuf::Value

Returns Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metrics_schema_uri ⇒ ::String

Returns Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.

Returns:

  • (::String) —

    Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_explanation ⇒ ::Google::Cloud::AIPlatform::V1::ModelExplanation

Returns Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

Returns:

  • (::Google::Cloud::AIPlatform::V1::ModelExplanation) —

    Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the ModelEvaluation.

Returns:

  • (::String) —

    Output only. The resource name of the ModelEvaluation.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#slice_dimensions ⇒ ::Array<::String>

Returns All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb', line 91

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

  # @!attribute [rw] explanation_type
  #   @return [::String]
  #     Explanation type.
  #
  #     For AutoML Image Classification models, possible values are:
  #
  #       * `image-integrated-gradients`
  #       * `image-xrai`
  # @!attribute [rw] explanation_spec
  #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
  #     Explanation spec details.
  class ModelEvaluationExplanationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end