google-cloud-ai_platform-v1 0.16.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +10 -7
  3. data/lib/google/cloud/ai_platform/v1/dataset_service.rb +1 -1
  4. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +28 -21
  5. data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +1 -1
  6. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +10 -9
  7. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +1 -1
  8. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +53 -50
  9. data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +1 -1
  10. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +18 -14
  11. data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +1 -1
  12. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +8 -4
  13. data/lib/google/cloud/ai_platform/v1/index_service.rb +1 -1
  14. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +53 -36
  15. data/lib/google/cloud/ai_platform/v1/job_service.rb +1 -1
  16. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +33 -36
  17. data/lib/google/cloud/ai_platform/v1/metadata_service.rb +1 -1
  18. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +3 -4
  19. data/lib/google/cloud/ai_platform/v1/migration_service.rb +1 -1
  20. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +44 -22
  21. data/lib/google/cloud/ai_platform/v1/model_service.rb +1 -1
  22. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +28 -17
  23. data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +1 -1
  24. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +28 -19
  25. data/lib/google/cloud/ai_platform/v1/prediction_service.rb +1 -1
  26. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +5 -3
  27. data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +1 -1
  28. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +165 -71
  29. data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +1 -1
  30. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  31. data/lib/google/cloud/ai_platform/v1/vizier_service.rb +1 -1
  32. data/lib/google/cloud/ai_platform/v1.rb +2 -2
  33. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +8 -0
  34. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +2 -0
  35. data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +2 -1
  36. data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +24 -14
  37. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +1 -0
  38. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +10 -5
  39. data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +16 -9
  40. data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +10 -6
  41. data/lib/google/cloud/aiplatform/v1/study_pb.rb +1 -0
  42. data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +17 -0
  43. data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +8 -8
  44. data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +9 -6
  45. data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +2 -2
  46. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +183 -50
  47. data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +8 -7
  48. data/proto_docs/google/cloud/aiplatform/v1/context.rb +2 -2
  49. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +22 -17
  50. data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +6 -5
  51. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +16 -16
  52. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +33 -17
  53. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +59 -32
  54. data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +2 -2
  55. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +38 -23
  56. data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +57 -35
  57. data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +8 -6
  58. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +111 -75
  59. data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +58 -38
  60. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +9 -6
  61. data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +2 -1
  62. data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +12 -11
  63. data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb +6 -2
  64. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +27 -19
  65. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +138 -99
  66. data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +9 -7
  67. data/proto_docs/google/cloud/aiplatform/v1/index.rb +18 -17
  68. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +36 -24
  69. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +49 -29
  70. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +35 -17
  71. data/proto_docs/google/cloud/aiplatform/v1/io.rb +2 -1
  72. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +94 -57
  73. data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +53 -43
  74. data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +5 -5
  75. data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +3 -3
  76. data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +141 -91
  77. data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +3 -3
  78. data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +18 -15
  79. data/proto_docs/google/cloud/aiplatform/v1/model.rb +179 -132
  80. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +21 -17
  81. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +7 -6
  82. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +11 -7
  83. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +4 -2
  84. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +110 -54
  85. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +56 -42
  86. data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +42 -22
  87. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +42 -28
  88. data/proto_docs/google/cloud/aiplatform/v1/saved_query.rb +2 -2
  89. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +19 -11
  90. data/proto_docs/google/cloud/aiplatform/v1/study.rb +42 -25
  91. data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +2 -2
  92. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +8 -7
  93. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +2 -1
  94. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +203 -109
  95. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +8 -6
  96. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +84 -59
  97. data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +2 -2
  98. data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +40 -20
  99. data/proto_docs/google/rpc/status.rb +4 -2
  100. metadata +5 -5
@@ -21,8 +21,10 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Explanation of a prediction (provided in {::Google::Cloud::AIPlatform::V1::PredictResponse#predictions PredictResponse.predictions})
25
- # produced by the Model on a given {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}.
24
+ # Explanation of a prediction (provided in
25
+ # {::Google::Cloud::AIPlatform::V1::PredictResponse#predictions PredictResponse.predictions})
26
+ # produced by the Model on a given
27
+ # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}.
26
28
  # @!attribute [r] attributions
27
29
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Attribution>]
28
30
  # Output only. Feature attributions grouped by predicted outputs.
@@ -31,14 +33,19 @@ module Google
31
33
  # predict only one score, there is only one attibution that explains the
32
34
  # predicted output. For Models that predict multiple outputs, such as
33
35
  # multiclass Models that predict multiple classes, each element explains one
34
- # specific item. {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} can be used to identify which
35
- # output this attribution is explaining.
36
- #
37
- # If users set {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k ExplanationParameters.top_k}, the attributions are sorted
38
- # by [instance_output_value][Attributions.instance_output_value] in
39
- # descending order. If {::Google::Cloud::AIPlatform::V1::ExplanationParameters#output_indices ExplanationParameters.output_indices} is specified,
40
- # the attributions are stored by {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} in the same
41
- # order as they appear in the output_indices.
36
+ # specific item.
37
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
38
+ # can be used to identify which output this attribution is explaining.
39
+ #
40
+ # If users set
41
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k ExplanationParameters.top_k},
42
+ # the attributions are sorted by
43
+ # [instance_output_value][Attributions.instance_output_value] in descending
44
+ # order. If
45
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#output_indices ExplanationParameters.output_indices}
46
+ # is specified, the attributions are stored by
47
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
48
+ # in the same order as they appear in the output_indices.
42
49
  # @!attribute [r] neighbors
43
50
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Neighbor>]
44
51
  # Output only. List of the nearest neighbors for example-based explanations.
@@ -53,24 +60,28 @@ module Google
53
60
  # Aggregated explanation metrics for a Model over a set of instances.
54
61
  # @!attribute [r] mean_attributions
55
62
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Attribution>]
56
- # Output only. Aggregated attributions explaining the Model's prediction outputs over the
57
- # set of instances. The attributions are grouped by outputs.
63
+ # Output only. Aggregated attributions explaining the Model's prediction
64
+ # outputs over the set of instances. The attributions are grouped by outputs.
58
65
  #
59
66
  # For Models that predict only one output, such as regression Models that
60
67
  # predict only one score, there is only one attibution that explains the
61
68
  # predicted output. For Models that predict multiple outputs, such as
62
69
  # multiclass Models that predict multiple classes, each element explains one
63
- # specific item. {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} can be used to identify which
64
- # output this attribution is explaining.
70
+ # specific item.
71
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
72
+ # can be used to identify which output this attribution is explaining.
65
73
  #
66
- # The {::Google::Cloud::AIPlatform::V1::Attribution#baseline_output_value baselineOutputValue},
67
- # {::Google::Cloud::AIPlatform::V1::Attribution#instance_output_value instanceOutputValue} and
68
- # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions} fields are
69
- # averaged over the test data.
74
+ # The
75
+ # {::Google::Cloud::AIPlatform::V1::Attribution#baseline_output_value baselineOutputValue},
76
+ # {::Google::Cloud::AIPlatform::V1::Attribution#instance_output_value instanceOutputValue}
77
+ # and
78
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions}
79
+ # fields are averaged over the test data.
70
80
  #
71
81
  # NOTE: Currently AutoML tabular classification Models produce only one
72
82
  # attribution, which averages attributions over all the classes it predicts.
73
- # {::Google::Cloud::AIPlatform::V1::Attribution#approximation_error Attribution.approximation_error} is not populated.
83
+ # {::Google::Cloud::AIPlatform::V1::Attribution#approximation_error Attribution.approximation_error}
84
+ # is not populated.
74
85
  class ModelExplanation
75
86
  include ::Google::Protobuf::MessageExts
76
87
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -79,32 +90,39 @@ module Google
79
90
  # Attribution that explains a particular prediction output.
80
91
  # @!attribute [r] baseline_output_value
81
92
  # @return [::Float]
82
- # Output only. Model predicted output if the input instance is constructed from the
83
- # baselines of all the features defined in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}.
93
+ # Output only. Model predicted output if the input instance is constructed
94
+ # from the baselines of all the features defined in
95
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}.
84
96
  # The field name of the output is determined by the key in
85
97
  # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
86
98
  #
87
99
  # If the Model's predicted output has multiple dimensions (rank > 1), this is
88
- # the value in the output located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
100
+ # the value in the output located by
101
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
89
102
  #
90
103
  # If there are multiple baselines, their output values are averaged.
91
104
  # @!attribute [r] instance_output_value
92
105
  # @return [::Float]
93
106
  # Output only. Model predicted output on the corresponding [explanation
94
107
  # instance][ExplainRequest.instances]. The field name of the output is
95
- # determined by the key in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
108
+ # determined by the key in
109
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
96
110
  #
97
111
  # If the Model predicted output has multiple dimensions, this is the value in
98
- # the output located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
112
+ # the output located by
113
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
99
114
  # @!attribute [r] feature_attributions
100
115
  # @return [::Google::Protobuf::Value]
101
- # Output only. Attributions of each explained feature. Features are extracted from
102
- # the {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances prediction instances} according to
103
- # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs explanation metadata for inputs}.
116
+ # Output only. Attributions of each explained feature. Features are extracted
117
+ # from the [prediction
118
+ # instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
119
+ # to [explanation metadata for
120
+ # inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
104
121
  #
105
122
  # The value is a struct, whose keys are the name of the feature. The values
106
- # are how much the feature in the {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}
107
- # contributed to the predicted result.
123
+ # are how much the feature in the
124
+ # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance} contributed
125
+ # to the predicted result.
108
126
  #
109
127
  # The format of the value is determined by the feature's input format:
110
128
  #
@@ -120,10 +138,13 @@ module Google
120
138
  # struct. The formats of the values in the attribution struct are
121
139
  # determined by the formats of the values in the feature struct.
122
140
  #
123
- # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#feature_attributions_schema_uri ExplanationMetadata.feature_attributions_schema_uri} field,
124
- # pointed to by the {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} field of the
125
- # {::Google::Cloud::AIPlatform::V1::Endpoint#deployed_models Endpoint.deployed_models} object, points to the schema file that
126
- # describes the features and their attribution values (if it is populated).
141
+ # The
142
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#feature_attributions_schema_uri ExplanationMetadata.feature_attributions_schema_uri}
143
+ # field, pointed to by the
144
+ # {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} field of the
145
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#deployed_models Endpoint.deployed_models}
146
+ # object, points to the schema file that describes the features and their
147
+ # attribution values (if it is populated).
127
148
  # @!attribute [r] output_index
128
149
  # @return [::Array<::Integer>]
129
150
  # Output only. The index that locates the explained prediction output.
@@ -135,8 +156,9 @@ module Google
135
156
  # of the output vector. Indices start from 0.
136
157
  # @!attribute [r] output_display_name
137
158
  # @return [::String]
138
- # Output only. The display name of the output identified by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}. For example,
139
- # the predicted class name by a multi-classification Model.
159
+ # Output only. The display name of the output identified by
160
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}. For
161
+ # example, the predicted class name by a multi-classification Model.
140
162
  #
141
163
  # This field is only populated iff the Model predicts display names as a
142
164
  # separate field along with the explained output. The predicted display name
@@ -144,20 +166,26 @@ module Google
144
166
  # output_index.
145
167
  # @!attribute [r] approximation_error
146
168
  # @return [::Float]
147
- # Output only. Error of {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions feature_attributions} caused by approximation used in the
148
- # explanation method. Lower value means more precise attributions.
169
+ # Output only. Error of
170
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions feature_attributions}
171
+ # caused by approximation used in the explanation method. Lower value means
172
+ # more precise attributions.
149
173
  #
150
174
  # * For Sampled Shapley
151
175
  # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#sampled_shapley_attribution attribution},
152
- # increasing {::Google::Cloud::AIPlatform::V1::SampledShapleyAttribution#path_count path_count} might reduce
153
- # the error.
176
+ # increasing
177
+ # {::Google::Cloud::AIPlatform::V1::SampledShapleyAttribution#path_count path_count}
178
+ # might reduce the error.
154
179
  # * For Integrated Gradients
155
180
  # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution attribution},
156
- # increasing {::Google::Cloud::AIPlatform::V1::IntegratedGradientsAttribution#step_count step_count} might
157
- # reduce the error.
158
- # * For {::Google::Cloud::AIPlatform::V1::ExplanationParameters#xrai_attribution XRAI attribution},
159
181
  # increasing
160
- # {::Google::Cloud::AIPlatform::V1::XraiAttribution#step_count step_count} might reduce the error.
182
+ # {::Google::Cloud::AIPlatform::V1::IntegratedGradientsAttribution#step_count step_count}
183
+ # might reduce the error.
184
+ # * For [XRAI
185
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
186
+ # increasing
187
+ # {::Google::Cloud::AIPlatform::V1::XraiAttribution#step_count step_count} might
188
+ # reduce the error.
161
189
  #
162
190
  # See [this introduction](/vertex-ai/docs/explainable-ai/overview)
163
191
  # for more information.
@@ -226,13 +254,14 @@ module Google
226
254
  # @!attribute [rw] output_indices
227
255
  # @return [::Google::Protobuf::ListValue]
228
256
  # If populated, only returns attributions that have
229
- # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index} contained in output_indices. It
230
- # must be an ndarray of integers, with the same shape of the output it's
231
- # explaining.
257
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}
258
+ # contained in output_indices. It must be an ndarray of integers, with the
259
+ # same shape of the output it's explaining.
232
260
  #
233
- # If not populated, returns attributions for {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k top_k} indices of outputs.
234
- # If neither top_k nor output_indices is populated, returns the argmax
235
- # index of the outputs.
261
+ # If not populated, returns attributions for
262
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k top_k} indices of
263
+ # outputs. If neither top_k nor output_indices is populated, returns the
264
+ # argmax index of the outputs.
236
265
  #
237
266
  # Only applicable to Models that predict multiple outputs (e,g, multi-class
238
267
  # Models that predict multiple classes).
@@ -246,8 +275,8 @@ module Google
246
275
  # approximate the value rather than considering all subsets of features.
247
276
  # @!attribute [rw] path_count
248
277
  # @return [::Integer]
249
- # Required. The number of feature permutations to consider when approximating the
250
- # Shapley values.
278
+ # Required. The number of feature permutations to consider when approximating
279
+ # the Shapley values.
251
280
  #
252
281
  # Valid range of its value is [1, 50], inclusively.
253
282
  class SampledShapleyAttribution
@@ -339,16 +368,18 @@ module Google
339
368
  # paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.
340
369
  #
341
370
  # If the distribution is different per feature, set
342
- # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#feature_noise_sigma feature_noise_sigma} instead
343
- # for each feature.
371
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#feature_noise_sigma feature_noise_sigma}
372
+ # instead for each feature.
344
373
  # @!attribute [rw] feature_noise_sigma
345
374
  # @return [::Google::Cloud::AIPlatform::V1::FeatureNoiseSigma]
346
- # This is similar to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}, but
347
- # provides additional flexibility. A separate noise sigma can be provided
348
- # for each feature, which is useful if their distributions are different.
349
- # No noise is added to features that are not set. If this field is unset,
350
- # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma} will be used for all
351
- # features.
375
+ # This is similar to
376
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma},
377
+ # but provides additional flexibility. A separate noise sigma can be
378
+ # provided for each feature, which is useful if their distributions are
379
+ # different. No noise is added to features that are not set. If this field
380
+ # is unset,
381
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}
382
+ # will be used for all features.
352
383
  # @!attribute [rw] noisy_sample_count
353
384
  # @return [::Integer]
354
385
  # The number of gradient samples to use for
@@ -375,13 +406,14 @@ module Google
375
406
  # @return [::String]
376
407
  # The name of the input feature for which noise sigma is provided. The
377
408
  # features are defined in
378
- # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs explanation metadata inputs}.
409
+ # [explanation metadata
410
+ # inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
379
411
  # @!attribute [rw] sigma
380
412
  # @return [::Float]
381
413
  # This represents the standard deviation of the Gaussian kernel that will
382
414
  # be used to add noise to the feature prior to computing gradients. Similar
383
- # to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma} but represents the
384
- # noise added to the current feature. Defaults to 0.1.
415
+ # to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}
416
+ # but represents the noise added to the current feature. Defaults to 0.1.
385
417
  class NoiseSigmaForFeature
386
418
  include ::Google::Protobuf::MessageExts
387
419
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -405,13 +437,14 @@ module Google
405
437
  extend ::Google::Protobuf::MessageExts::ClassMethods
406
438
  end
407
439
 
408
- # The {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} entries that can be overridden at
409
- # {::Google::Cloud::AIPlatform::V1::PredictionService::Client#explain online explanation} time.
440
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} entries
441
+ # that can be overridden at [online
442
+ # explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
410
443
  # @!attribute [rw] parameters
411
444
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationParameters]
412
445
  # The parameters to be overridden. Note that the
413
- # [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be changed. If not specified,
414
- # no parameter is overridden.
446
+ # [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be
447
+ # changed. If not specified, no parameter is overridden.
415
448
  # @!attribute [rw] metadata
416
449
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride]
417
450
  # The metadata to be overridden. If not specified, no metadata is overridden.
@@ -423,21 +456,24 @@ module Google
423
456
  extend ::Google::Protobuf::MessageExts::ClassMethods
424
457
  end
425
458
 
426
- # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata ExplanationMetadata} entries that can be overridden at
427
- # {::Google::Cloud::AIPlatform::V1::PredictionService::Client#explain online explanation} time.
459
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata ExplanationMetadata}
460
+ # entries that can be overridden at [online
461
+ # explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
428
462
  # @!attribute [rw] inputs
429
463
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride::InputMetadataOverride}]
430
- # Required. Overrides the {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs input metadata} of the features.
431
- # The key is the name of the feature to be overridden. The keys specified
432
- # here must exist in the input metadata to be overridden. If a feature is
433
- # not specified here, the corresponding feature's input metadata is not
434
- # overridden.
464
+ # Required. Overrides the [input
465
+ # metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the
466
+ # features. The key is the name of the feature to be overridden. The keys
467
+ # specified here must exist in the input metadata to be overridden. If a
468
+ # feature is not specified here, the corresponding feature's input metadata
469
+ # is not overridden.
435
470
  class ExplanationMetadataOverride
436
471
  include ::Google::Protobuf::MessageExts
437
472
  extend ::Google::Protobuf::MessageExts::ClassMethods
438
473
 
439
- # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata input metadata} entries to be
440
- # overridden.
474
+ # The [input
475
+ # metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata]
476
+ # entries to be overridden.
441
477
  # @!attribute [rw] input_baselines
442
478
  # @return [::Array<::Google::Protobuf::Value>]
443
479
  # Baseline inputs for this feature.
@@ -24,17 +24,18 @@ module Google
24
24
  # Metadata describing the Model's input and output for explanation.
25
25
  # @!attribute [rw] inputs
26
26
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata}]
27
- # Required. Map from feature names to feature input metadata. Keys are the name of the
28
- # features. Values are the specification of the feature.
27
+ # Required. Map from feature names to feature input metadata. Keys are the
28
+ # name of the features. Values are the specification of the feature.
29
29
  #
30
30
  # An empty InputMetadata is valid. It describes a text feature which has the
31
- # name specified as the key in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}. The baseline
32
- # of the empty feature is chosen by Vertex AI.
31
+ # name specified as the key in
32
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}.
33
+ # The baseline of the empty feature is chosen by Vertex AI.
33
34
  #
34
35
  # For Vertex AI-provided Tensorflow images, the key can be any friendly
35
36
  # name of the feature. Once specified,
36
- # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions} are keyed by
37
- # this key (if not grouped with another feature).
37
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions}
38
+ # are keyed by this key (if not grouped with another feature).
38
39
  #
39
40
  # For custom images, the key must match with the key in
40
41
  # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}.
@@ -52,7 +53,8 @@ module Google
52
53
  # @!attribute [rw] feature_attributions_schema_uri
53
54
  # @return [::String]
54
55
  # Points to a YAML file stored on Google Cloud Storage describing the format
55
- # of the {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions feature attributions}.
56
+ # of the [feature
57
+ # attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
56
58
  # The schema is defined as an OpenAPI 3.0.2 [Schema
57
59
  # Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
58
60
  # AutoML tabular Models always have this field populated by Vertex AI.
@@ -68,15 +70,18 @@ module Google
68
70
 
69
71
  # Metadata of the input of a feature.
70
72
  #
71
- # Fields other than {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#input_baselines InputMetadata.input_baselines} are applicable only
72
- # for Models that are using Vertex AI-provided images for Tensorflow.
73
+ # Fields other than
74
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#input_baselines InputMetadata.input_baselines}
75
+ # are applicable only for Models that are using Vertex AI-provided images for
76
+ # Tensorflow.
73
77
  # @!attribute [rw] input_baselines
74
78
  # @return [::Array<::Google::Protobuf::Value>]
75
79
  # Baseline inputs for this feature.
76
80
  #
77
81
  # If no baseline is specified, Vertex AI chooses the baseline for this
78
82
  # feature. If multiple baselines are specified, Vertex AI returns the
79
- # average attributions across them in {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions}.
83
+ # average attributions across them in
84
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions}.
80
85
  #
81
86
  # For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape
82
87
  # of each baseline must match the shape of the input tensor. If a scalar is
@@ -84,9 +89,9 @@ module Google
84
89
  #
85
90
  # For custom images, the element of the baselines must be in the same
86
91
  # format as the feature's input in the
87
- # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}[]. The schema of any single instance
88
- # may be specified via Endpoint's DeployedModels'
89
- # [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
92
+ # {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}[]. The
93
+ # schema of any single instance may be specified via Endpoint's
94
+ # DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
90
95
  # [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
91
96
  # {::Google::Cloud::AIPlatform::V1::PredictSchemata#instance_schema_uri instance_schema_uri}.
92
97
  # @!attribute [rw] input_tensor_name
@@ -119,15 +124,18 @@ module Google
119
124
  # @!attribute [rw] index_feature_mapping
120
125
  # @return [::Array<::String>]
121
126
  # A list of feature names for each index in the input tensor.
122
- # Required when the input {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoding InputMetadata.encoding} is BAG_OF_FEATURES,
123
- # BAG_OF_FEATURES_SPARSE, INDICATOR.
127
+ # Required when the input
128
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoding InputMetadata.encoding}
129
+ # is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
124
130
  # @!attribute [rw] encoded_tensor_name
125
131
  # @return [::String]
126
132
  # Encoded tensor is a transformation of the input tensor. Must be provided
127
133
  # if choosing
128
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution}
129
- # or {::Google::Cloud::AIPlatform::V1::ExplanationParameters#xrai_attribution XRAI attribution} and the
130
- # input tensor is not differentiable.
134
+ # [Integrated Gradients
135
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]
136
+ # or [XRAI
137
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution]
138
+ # and the input tensor is not differentiable.
131
139
  #
132
140
  # An encoded tensor is generated if the input tensor is encoded by a lookup
133
141
  # table.
@@ -147,7 +155,8 @@ module Google
147
155
  # name will be treated as one feature when computing attributions. Features
148
156
  # grouped together can have different shapes in value. If provided, there
149
157
  # will be one single attribution generated in
150
- # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions}, keyed by the group name.
158
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions Attribution.feature_attributions},
159
+ # keyed by the group name.
151
160
  class InputMetadata
152
161
  include ::Google::Protobuf::MessageExts
153
162
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -185,7 +194,8 @@ module Google
185
194
  # @!attribute [rw] type
186
195
  # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata::Visualization::Type]
187
196
  # Type of the image visualization. Only applicable to
188
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution}.
197
+ # [Integrated Gradients
198
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
189
199
  # OUTLINES shows regions of attribution, while PIXELS shows per-pixel
190
200
  # attribution. Defaults to OUTLINES.
191
201
  # @!attribute [rw] polarity
@@ -197,12 +207,14 @@ module Google
197
207
  # The color scheme used for the highlighted areas.
198
208
  #
199
209
  # Defaults to PINK_GREEN for
200
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution},
210
+ # [Integrated Gradients
211
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
201
212
  # which shows positive attributions in green and negative in pink.
202
213
  #
203
214
  # Defaults to VIRIDIS for
204
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#xrai_attribution XRAI attribution}, which
205
- # highlights the most influential regions in yellow and the least
215
+ # [XRAI
216
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
217
+ # which highlights the most influential regions in yellow and the least
206
218
  # influential in blue.
207
219
  # @!attribute [rw] clip_percent_upperbound
208
220
  # @return [::Float]
@@ -225,7 +237,8 @@ module Google
225
237
  extend ::Google::Protobuf::MessageExts::ClassMethods
226
238
 
227
239
  # Type of the image visualization. Only applicable to
228
- # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution Integrated Gradients attribution}.
240
+ # [Integrated Gradients
241
+ # attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
229
242
  module Type
230
243
  # Should not be used.
231
244
  TYPE_UNSPECIFIED = 0
@@ -312,8 +325,9 @@ module Google
312
325
  IDENTITY = 1
313
326
 
314
327
  # The tensor represents a bag of features where each index maps to
315
- # a feature. {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping} must be provided for
316
- # this encoding. For example:
328
+ # a feature.
329
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
330
+ # must be provided for this encoding. For example:
317
331
  # ```
318
332
  # input = [27, 6.0, 150]
319
333
  # index_feature_mapping = ["age", "height", "weight"]
@@ -322,8 +336,9 @@ module Google
322
336
 
323
337
  # The tensor represents a bag of features where each index maps to a
324
338
  # feature. Zero values in the tensor indicates feature being
325
- # non-existent. {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping} must be provided
326
- # for this encoding. For example:
339
+ # non-existent.
340
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
341
+ # must be provided for this encoding. For example:
327
342
  # ```
328
343
  # input = [2, 0, 5, 0, 1]
329
344
  # index_feature_mapping = ["a", "b", "c", "d", "e"]
@@ -331,7 +346,8 @@ module Google
331
346
  BAG_OF_FEATURES_SPARSE = 3
332
347
 
333
348
  # The tensor is a list of binaries representing whether a feature exists
334
- # or not (1 indicates existence). {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
349
+ # or not (1 indicates existence).
350
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#index_feature_mapping InputMetadata.index_feature_mapping}
335
351
  # must be provided for this encoding. For example:
336
352
  # ```
337
353
  # input = [1, 0, 1, 0, 1]
@@ -340,8 +356,9 @@ module Google
340
356
  INDICATOR = 4
341
357
 
342
358
  # The tensor is encoded into a 1-dimensional array represented by an
343
- # encoded tensor. {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name} must be provided
344
- # for this encoding. For example:
359
+ # encoded tensor.
360
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name}
361
+ # must be provided for this encoding. For example:
345
362
  # ```
346
363
  # input = ["This", "is", "a", "test", "."]
347
364
  # encoded = [0.1, 0.2, 0.3, 0.4, 0.5]
@@ -350,9 +367,9 @@ module Google
350
367
 
351
368
  # Select this encoding when the input tensor is encoded into a
352
369
  # 2-dimensional array represented by an encoded tensor.
353
- # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name} must be provided for this
354
- # encoding. The first dimension of the encoded tensor's shape is the same
355
- # as the input tensor's shape. For example:
370
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata#encoded_tensor_name InputMetadata.encoded_tensor_name}
371
+ # must be provided for this encoding. The first dimension of the encoded
372
+ # tensor's shape is the same as the input tensor's shape. For example:
356
373
  # ```
357
374
  # input = ["This", "is", "a", "test", "."]
358
375
  # encoded = [[0.1, 0.2, 0.3, 0.4, 0.5],
@@ -378,8 +395,10 @@ module Google
378
395
  #
379
396
  # The shape of the value must be an n-dimensional array of strings. The
380
397
  # number of dimensions must match that of the outputs to be explained.
381
- # The {::Google::Cloud::AIPlatform::V1::Attribution#output_display_name Attribution.output_display_name} is populated by locating in the
382
- # mapping with {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}.
398
+ # The
399
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_display_name Attribution.output_display_name}
400
+ # is populated by locating in the mapping with
401
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}.
383
402
  # @!attribute [rw] display_name_mapping_key
384
403
  # @return [::String]
385
404
  # Specify a field name in the prediction to look for the display name.
@@ -387,8 +406,9 @@ module Google
387
406
  # Use this if the prediction contains the display names for the outputs.
388
407
  #
389
408
  # The display names in the prediction must have the same shape of the
390
- # outputs, so that it can be located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} for
391
- # a specific output.
409
+ # outputs, so that it can be located by
410
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
411
+ # for a specific output.
392
412
  # @!attribute [rw] output_tensor_name
393
413
  # @return [::String]
394
414
  # Name of the output tensor. Required and is only applicable to Vertex
@@ -65,16 +65,17 @@ module Google
65
65
  # "overwrite" update happens.
66
66
  # @!attribute [rw] disable_monitoring
67
67
  # @return [::Boolean]
68
- # Optional. If not set, use the monitoring_config defined for the EntityType this
69
- # Feature belongs to.
70
- # Only Features with type ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL, STRING, DOUBLE or
71
- # INT64 can enable monitoring.
68
+ # Optional. If not set, use the monitoring_config defined for the EntityType
69
+ # this Feature belongs to. Only Features with type
70
+ # ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL,
71
+ # STRING, DOUBLE or INT64 can enable monitoring.
72
72
  #
73
73
  # If set to true, all types of data monitoring are disabled despite the
74
74
  # config on EntityType.
75
75
  # @!attribute [r] monitoring_stats_anomalies
76
76
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Feature::MonitoringStatsAnomaly>]
77
- # Output only. The list of historical stats and anomalies with specified objectives.
77
+ # Output only. The list of historical stats and anomalies with specified
78
+ # objectives.
78
79
  class Feature
79
80
  include ::Google::Protobuf::MessageExts
80
81
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -82,7 +83,9 @@ module Google
82
83
  # A list of historical [Snapshot
83
84
  # Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] or [Import Feature
84
85
  # Analysis] [FeaturestoreMonitoringConfig.ImportFeatureAnalysis] stats
85
- # requested by user, sorted by {::Google::Cloud::AIPlatform::V1::FeatureStatsAnomaly#start_time FeatureStatsAnomaly.start_time} descending.
86
+ # requested by user, sorted by
87
+ # {::Google::Cloud::AIPlatform::V1::FeatureStatsAnomaly#start_time FeatureStatsAnomaly.start_time}
88
+ # descending.
86
89
  # @!attribute [r] objective
87
90
  # @return [::Google::Cloud::AIPlatform::V1::Feature::MonitoringStatsAnomaly::Objective]
88
91
  # Output only. The objective for each stats.
@@ -35,7 +35,8 @@ module Google
35
35
  # Feature importance score, only populated when cross-feature monitoring is
36
36
  # enabled. For now only used to represent feature attribution score within
37
37
  # range [0, 1] for
38
- # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveType::FEATURE_ATTRIBUTION_SKEW ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW} and
38
+ # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveType::FEATURE_ATTRIBUTION_SKEW ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW}
39
+ # and
39
40
  # {::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveType::FEATURE_ATTRIBUTION_DRIFT ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT}.
40
41
  # @!attribute [rw] stats_uri
41
42
  # @return [::String]