google-cloud-ai_platform-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (289) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +1364 -0
  7. data/lib/google/cloud/ai_platform/v1/dataset_service/credentials.rb +47 -0
  8. data/lib/google/cloud/ai_platform/v1/dataset_service/operations.rb +767 -0
  9. data/lib/google/cloud/ai_platform/v1/dataset_service/paths.rb +111 -0
  10. data/lib/google/cloud/ai_platform/v1/dataset_service.rb +51 -0
  11. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +1076 -0
  12. data/lib/google/cloud/ai_platform/v1/endpoint_service/credentials.rb +47 -0
  13. data/lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb +767 -0
  14. data/lib/google/cloud/ai_platform/v1/endpoint_service/paths.rb +124 -0
  15. data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +50 -0
  16. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +508 -0
  17. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/credentials.rb +47 -0
  18. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/paths.rb +54 -0
  19. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +49 -0
  20. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +2707 -0
  21. data/lib/google/cloud/ai_platform/v1/featurestore_service/credentials.rb +47 -0
  22. data/lib/google/cloud/ai_platform/v1/featurestore_service/operations.rb +767 -0
  23. data/lib/google/cloud/ai_platform/v1/featurestore_service/paths.rb +113 -0
  24. data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +50 -0
  25. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +1146 -0
  26. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/credentials.rb +47 -0
  27. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/operations.rb +767 -0
  28. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/paths.rb +88 -0
  29. data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +50 -0
  30. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +823 -0
  31. data/lib/google/cloud/ai_platform/v1/index_service/credentials.rb +47 -0
  32. data/lib/google/cloud/ai_platform/v1/index_service/operations.rb +767 -0
  33. data/lib/google/cloud/ai_platform/v1/index_service/paths.rb +88 -0
  34. data/lib/google/cloud/ai_platform/v1/index_service.rb +50 -0
  35. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +3236 -0
  36. data/lib/google/cloud/ai_platform/v1/job_service/credentials.rb +47 -0
  37. data/lib/google/cloud/ai_platform/v1/job_service/operations.rb +767 -0
  38. data/lib/google/cloud/ai_platform/v1/job_service/paths.rb +259 -0
  39. data/lib/google/cloud/ai_platform/v1/job_service.rb +50 -0
  40. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +3654 -0
  41. data/lib/google/cloud/ai_platform/v1/metadata_service/credentials.rb +47 -0
  42. data/lib/google/cloud/ai_platform/v1/metadata_service/operations.rb +767 -0
  43. data/lib/google/cloud/ai_platform/v1/metadata_service/paths.rb +153 -0
  44. data/lib/google/cloud/ai_platform/v1/metadata_service.rb +50 -0
  45. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +538 -0
  46. data/lib/google/cloud/ai_platform/v1/migration_service/credentials.rb +47 -0
  47. data/lib/google/cloud/ai_platform/v1/migration_service/operations.rb +767 -0
  48. data/lib/google/cloud/ai_platform/v1/migration_service/paths.rb +148 -0
  49. data/lib/google/cloud/ai_platform/v1/migration_service.rb +51 -0
  50. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +1355 -0
  51. data/lib/google/cloud/ai_platform/v1/model_service/credentials.rb +47 -0
  52. data/lib/google/cloud/ai_platform/v1/model_service/operations.rb +767 -0
  53. data/lib/google/cloud/ai_platform/v1/model_service/paths.rb +151 -0
  54. data/lib/google/cloud/ai_platform/v1/model_service.rb +50 -0
  55. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +1384 -0
  56. data/lib/google/cloud/ai_platform/v1/pipeline_service/credentials.rb +47 -0
  57. data/lib/google/cloud/ai_platform/v1/pipeline_service/operations.rb +767 -0
  58. data/lib/google/cloud/ai_platform/v1/pipeline_service/paths.rb +225 -0
  59. data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +52 -0
  60. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +650 -0
  61. data/lib/google/cloud/ai_platform/v1/prediction_service/credentials.rb +47 -0
  62. data/lib/google/cloud/ai_platform/v1/prediction_service/paths.rb +52 -0
  63. data/lib/google/cloud/ai_platform/v1/prediction_service.rb +49 -0
  64. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +826 -0
  65. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/credentials.rb +47 -0
  66. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/operations.rb +767 -0
  67. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/paths.rb +69 -0
  68. data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +55 -0
  69. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +3224 -0
  70. data/lib/google/cloud/ai_platform/v1/tensorboard_service/credentials.rb +48 -0
  71. data/lib/google/cloud/ai_platform/v1/tensorboard_service/operations.rb +767 -0
  72. data/lib/google/cloud/ai_platform/v1/tensorboard_service/paths.rb +138 -0
  73. data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +50 -0
  74. data/lib/google/cloud/ai_platform/v1/version.rb +28 -0
  75. data/lib/google/cloud/ai_platform/v1/vizier_service/client.rb +1793 -0
  76. data/lib/google/cloud/ai_platform/v1/vizier_service/credentials.rb +47 -0
  77. data/lib/google/cloud/ai_platform/v1/vizier_service/operations.rb +767 -0
  78. data/lib/google/cloud/ai_platform/v1/vizier_service/paths.rb +109 -0
  79. data/lib/google/cloud/ai_platform/v1/vizier_service.rb +54 -0
  80. data/lib/google/cloud/ai_platform/v1.rb +52 -0
  81. data/lib/google/cloud/aiplatform/v1/accelerator_type_pb.rb +29 -0
  82. data/lib/google/cloud/aiplatform/v1/annotation_pb.rb +35 -0
  83. data/lib/google/cloud/aiplatform/v1/annotation_spec_pb.rb +30 -0
  84. data/lib/google/cloud/aiplatform/v1/artifact_pb.rb +45 -0
  85. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +83 -0
  86. data/lib/google/cloud/aiplatform/v1/completion_stats_pb.rb +27 -0
  87. data/lib/google/cloud/aiplatform/v1/context_pb.rb +38 -0
  88. data/lib/google/cloud/aiplatform/v1/custom_job_pb.rb +84 -0
  89. data/lib/google/cloud/aiplatform/v1/data_item_pb.rb +32 -0
  90. data/lib/google/cloud/aiplatform/v1/data_labeling_job_pb.rb +78 -0
  91. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +53 -0
  92. data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +126 -0
  93. data/lib/google/cloud/aiplatform/v1/dataset_service_services_pb.rb +64 -0
  94. data/lib/google/cloud/aiplatform/v1/deployed_index_ref_pb.rb +26 -0
  95. data/lib/google/cloud/aiplatform/v1/deployed_model_ref_pb.rb +26 -0
  96. data/lib/google/cloud/aiplatform/v1/encryption_spec_pb.rb +24 -0
  97. data/lib/google/cloud/aiplatform/v1/endpoint_pb.rb +67 -0
  98. data/lib/google/cloud/aiplatform/v1/endpoint_service_pb.rb +90 -0
  99. data/lib/google/cloud/aiplatform/v1/endpoint_service_services_pb.rb +58 -0
  100. data/lib/google/cloud/aiplatform/v1/entity_type_pb.rb +32 -0
  101. data/lib/google/cloud/aiplatform/v1/env_var_pb.rb +25 -0
  102. data/lib/google/cloud/aiplatform/v1/event_pb.rb +36 -0
  103. data/lib/google/cloud/aiplatform/v1/execution_pb.rb +48 -0
  104. data/lib/google/cloud/aiplatform/v1/explanation_metadata_pb.rb +107 -0
  105. data/lib/google/cloud/aiplatform/v1/explanation_pb.rb +106 -0
  106. data/lib/google/cloud/aiplatform/v1/feature_monitoring_stats_pb.rb +30 -0
  107. data/lib/google/cloud/aiplatform/v1/feature_pb.rb +46 -0
  108. data/lib/google/cloud/aiplatform/v1/feature_selector_pb.rb +28 -0
  109. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb +86 -0
  110. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_services_pb.rb +51 -0
  111. data/lib/google/cloud/aiplatform/v1/featurestore_pb.rb +44 -0
  112. data/lib/google/cloud/aiplatform/v1/featurestore_service_pb.rb +280 -0
  113. data/lib/google/cloud/aiplatform/v1/featurestore_service_services_pb.rb +109 -0
  114. data/lib/google/cloud/aiplatform/v1/hyperparameter_tuning_job_pb.rb +46 -0
  115. data/lib/google/cloud/aiplatform/v1/index_endpoint_pb.rb +66 -0
  116. data/lib/google/cloud/aiplatform/v1/index_endpoint_service_pb.rb +101 -0
  117. data/lib/google/cloud/aiplatform/v1/index_endpoint_service_services_pb.rb +62 -0
  118. data/lib/google/cloud/aiplatform/v1/index_pb.rb +38 -0
  119. data/lib/google/cloud/aiplatform/v1/index_service_pb.rb +98 -0
  120. data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +55 -0
  121. data/lib/google/cloud/aiplatform/v1/io_pb.rb +56 -0
  122. data/lib/google/cloud/aiplatform/v1/job_service_pb.rb +217 -0
  123. data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +134 -0
  124. data/lib/google/cloud/aiplatform/v1/job_state_pb.rb +32 -0
  125. data/lib/google/cloud/aiplatform/v1/lineage_subgraph_pb.rb +28 -0
  126. data/lib/google/cloud/aiplatform/v1/machine_resources_pb.rb +59 -0
  127. data/lib/google/cloud/aiplatform/v1/manual_batch_tuning_parameters_pb.rb +24 -0
  128. data/lib/google/cloud/aiplatform/v1/metadata_schema_pb.rb +38 -0
  129. data/lib/google/cloud/aiplatform/v1/metadata_service_pb.rb +272 -0
  130. data/lib/google/cloud/aiplatform/v1/metadata_service_services_pb.rb +119 -0
  131. data/lib/google/cloud/aiplatform/v1/metadata_store_pb.rb +36 -0
  132. data/lib/google/cloud/aiplatform/v1/migratable_resource_pb.rb +59 -0
  133. data/lib/google/cloud/aiplatform/v1/migration_service_pb.rb +106 -0
  134. data/lib/google/cloud/aiplatform/v1/migration_service_services_pb.rb +51 -0
  135. data/lib/google/cloud/aiplatform/v1/model_deployment_monitoring_job_pb.rb +111 -0
  136. data/lib/google/cloud/aiplatform/v1/model_evaluation_pb.rb +33 -0
  137. data/lib/google/cloud/aiplatform/v1/model_evaluation_slice_pb.rb +36 -0
  138. data/lib/google/cloud/aiplatform/v1/model_monitoring_pb.rb +93 -0
  139. data/lib/google/cloud/aiplatform/v1/model_pb.rb +88 -0
  140. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +129 -0
  141. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +69 -0
  142. data/lib/google/cloud/aiplatform/v1/operation_pb.rb +32 -0
  143. data/lib/google/cloud/aiplatform/v1/pipeline_job_pb.rb +115 -0
  144. data/lib/google/cloud/aiplatform/v1/pipeline_service_pb.rb +88 -0
  145. data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +84 -0
  146. data/lib/google/cloud/aiplatform/v1/pipeline_state_pb.rb +31 -0
  147. data/lib/google/cloud/aiplatform/v1/prediction_service_pb.rb +57 -0
  148. data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +66 -0
  149. data/lib/google/cloud/aiplatform/v1/specialist_pool_pb.rb +30 -0
  150. data/lib/google/cloud/aiplatform/v1/specialist_pool_service_pb.rb +66 -0
  151. data/lib/google/cloud/aiplatform/v1/specialist_pool_service_services_pb.rb +58 -0
  152. data/lib/google/cloud/aiplatform/v1/study_pb.rb +191 -0
  153. data/lib/google/cloud/aiplatform/v1/tensorboard_data_pb.rb +56 -0
  154. data/lib/google/cloud/aiplatform/v1/tensorboard_experiment_pb.rb +33 -0
  155. data/lib/google/cloud/aiplatform/v1/tensorboard_pb.rb +36 -0
  156. data/lib/google/cloud/aiplatform/v1/tensorboard_run_pb.rb +32 -0
  157. data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +244 -0
  158. data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +115 -0
  159. data/lib/google/cloud/aiplatform/v1/tensorboard_time_series_pb.rb +48 -0
  160. data/lib/google/cloud/aiplatform/v1/training_pipeline_pb.rb +95 -0
  161. data/lib/google/cloud/aiplatform/v1/types_pb.rb +35 -0
  162. data/lib/google/cloud/aiplatform/v1/unmanaged_container_model_pb.rb +27 -0
  163. data/lib/google/cloud/aiplatform/v1/user_action_reference_pb.rb +27 -0
  164. data/lib/google/cloud/aiplatform/v1/value_pb.rb +27 -0
  165. data/lib/google/cloud/aiplatform/v1/vizier_service_pb.rb +136 -0
  166. data/lib/google/cloud/aiplatform/v1/vizier_service_services_pb.rb +90 -0
  167. data/lib/google-cloud-ai_platform-v1.rb +21 -0
  168. data/proto_docs/README.md +4 -0
  169. data/proto_docs/google/api/field_behavior.rb +71 -0
  170. data/proto_docs/google/api/httpbody.rb +80 -0
  171. data/proto_docs/google/api/resource.rb +222 -0
  172. data/proto_docs/google/cloud/aiplatform/v1/accelerator_type.rb +50 -0
  173. data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +92 -0
  174. data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +50 -0
  175. data/proto_docs/google/cloud/aiplatform/v1/artifact.rb +112 -0
  176. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +278 -0
  177. data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +46 -0
  178. data/proto_docs/google/cloud/aiplatform/v1/context.rb +92 -0
  179. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +272 -0
  180. data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +73 -0
  181. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +207 -0
  182. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +154 -0
  183. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +301 -0
  184. data/proto_docs/google/cloud/aiplatform/v1/deployed_index_ref.rb +38 -0
  185. data/proto_docs/google/cloud/aiplatform/v1/deployed_model_ref.rb +38 -0
  186. data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +40 -0
  187. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +227 -0
  188. data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +258 -0
  189. data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +79 -0
  190. data/proto_docs/google/cloud/aiplatform/v1/env_var.rb +44 -0
  191. data/proto_docs/google/cloud/aiplatform/v1/event.rb +79 -0
  192. data/proto_docs/google/cloud/aiplatform/v1/execution.rb +118 -0
  193. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +445 -0
  194. data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +419 -0
  195. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +115 -0
  196. data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +88 -0
  197. data/proto_docs/google/cloud/aiplatform/v1/feature_selector.rb +49 -0
  198. data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +115 -0
  199. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +203 -0
  200. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +978 -0
  201. data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +109 -0
  202. data/proto_docs/google/cloud/aiplatform/v1/index.rb +98 -0
  203. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +252 -0
  204. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +240 -0
  205. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +220 -0
  206. data/proto_docs/google/cloud/aiplatform/v1/io.rb +134 -0
  207. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +660 -0
  208. data/proto_docs/google/cloud/aiplatform/v1/job_state.rb +60 -0
  209. data/proto_docs/google/cloud/aiplatform/v1/lineage_subgraph.rb +42 -0
  210. data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +194 -0
  211. data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +41 -0
  212. data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +74 -0
  213. data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +912 -0
  214. data/proto_docs/google/cloud/aiplatform/v1/metadata_store.rb +62 -0
  215. data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +133 -0
  216. data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +260 -0
  217. data/proto_docs/google/cloud/aiplatform/v1/model.rb +562 -0
  218. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +293 -0
  219. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +60 -0
  220. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +68 -0
  221. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +257 -0
  222. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +329 -0
  223. data/proto_docs/google/cloud/aiplatform/v1/operation.rb +55 -0
  224. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +347 -0
  225. data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +258 -0
  226. data/proto_docs/google/cloud/aiplatform/v1/pipeline_state.rb +59 -0
  227. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +165 -0
  228. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.rb +52 -0
  229. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.rb +52 -0
  230. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.rb +47 -0
  231. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/text_classification.rb +46 -0
  232. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/text_extraction.rb +53 -0
  233. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/text_sentiment.rb +46 -0
  234. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/video_action_recognition.rb +59 -0
  235. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/video_classification.rb +59 -0
  236. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/video_object_tracking.rb +59 -0
  237. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_classification.rb +47 -0
  238. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.rb +47 -0
  239. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.rb +44 -0
  240. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.rb +47 -0
  241. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_classification.rb +72 -0
  242. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.rb +51 -0
  243. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/classification.rb +49 -0
  244. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.rb +58 -0
  245. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.rb +53 -0
  246. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.rb +47 -0
  247. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.rb +47 -0
  248. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.rb +60 -0
  249. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.rb +45 -0
  250. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/video_action_recognition.rb +60 -0
  251. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/video_classification.rb +73 -0
  252. data/proto_docs/google/cloud/aiplatform/v1/schema/predict/prediction/video_object_tracking.rb +91 -0
  253. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_classification.rb +142 -0
  254. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_object_detection.rb +134 -0
  255. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_segmentation.rb +120 -0
  256. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.rb +315 -0
  257. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_classification.rb +48 -0
  258. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_extraction.rb +46 -0
  259. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_sentiment.rb +55 -0
  260. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_action_recognition.rb +73 -0
  261. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_classification.rb +67 -0
  262. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_object_tracking.rb +78 -0
  263. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.rb +51 -0
  264. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool.rb +58 -0
  265. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +136 -0
  266. data/proto_docs/google/cloud/aiplatform/v1/study.rb +543 -0
  267. data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +89 -0
  268. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +110 -0
  269. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +82 -0
  270. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_run.rb +85 -0
  271. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +706 -0
  272. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +101 -0
  273. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +381 -0
  274. data/proto_docs/google/cloud/aiplatform/v1/types.rb +62 -0
  275. data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +44 -0
  276. data/proto_docs/google/cloud/aiplatform/v1/user_action_reference.rb +49 -0
  277. data/proto_docs/google/cloud/aiplatform/v1/value.rb +41 -0
  278. data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +332 -0
  279. data/proto_docs/google/longrunning/operations.rb +164 -0
  280. data/proto_docs/google/protobuf/any.rb +141 -0
  281. data/proto_docs/google/protobuf/duration.rb +98 -0
  282. data/proto_docs/google/protobuf/empty.rb +36 -0
  283. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  284. data/proto_docs/google/protobuf/struct.rb +96 -0
  285. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  286. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  287. data/proto_docs/google/rpc/status.rb +46 -0
  288. data/proto_docs/google/type/money.rb +43 -0
  289. metadata +479 -0
@@ -0,0 +1,79 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AIPlatform
23
+ module V1
24
+ # An edge describing the relationship between an Artifact and an Execution in
25
+ # a lineage graph.
26
+ # @!attribute [rw] artifact
27
+ # @return [::String]
28
+ # Required. The relative resource name of the Artifact in the Event.
29
+ # @!attribute [r] execution
30
+ # @return [::String]
31
+ # Output only. The relative resource name of the Execution in the Event.
32
+ # @!attribute [r] event_time
33
+ # @return [::Google::Protobuf::Timestamp]
34
+ # Output only. Time the Event occurred.
35
+ # @!attribute [rw] type
36
+ # @return [::Google::Cloud::AIPlatform::V1::Event::Type]
37
+ # Required. The type of the Event.
38
+ # @!attribute [rw] labels
39
+ # @return [::Google::Protobuf::Map{::String => ::String}]
40
+ # The labels with user-defined metadata to annotate Events.
41
+ #
42
+ # Label keys and values can be no longer than 64 characters
43
+ # (Unicode codepoints), can only contain lowercase letters, numeric
44
+ # characters, underscores and dashes. International characters are allowed.
45
+ # No more than 64 user labels can be associated with one Event (System
46
+ # labels are excluded).
47
+ #
48
+ # See https://goo.gl/xmQnxf for more information and examples of labels.
49
+ # System reserved label keys are prefixed with "aiplatform.googleapis.com/"
50
+ # and are immutable.
51
+ class Event
52
+ include ::Google::Protobuf::MessageExts
53
+ extend ::Google::Protobuf::MessageExts::ClassMethods
54
+
55
+ # @!attribute [rw] key
56
+ # @return [::String]
57
+ # @!attribute [rw] value
58
+ # @return [::String]
59
+ class LabelsEntry
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # Describes whether an Event's Artifact is the Execution's input or output.
65
+ module Type
66
+ # Unspecified whether input or output of the Execution.
67
+ TYPE_UNSPECIFIED = 0
68
+
69
+ # An input of the Execution.
70
+ INPUT = 1
71
+
72
+ # An output of the Execution.
73
+ OUTPUT = 2
74
+ end
75
+ end
76
+ end
77
+ end
78
+ end
79
+ end
@@ -0,0 +1,118 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AIPlatform
23
+ module V1
24
+ # Instance of a general execution.
25
+ # @!attribute [r] name
26
+ # @return [::String]
27
+ # Output only. The resource name of the Execution.
28
+ # @!attribute [rw] display_name
29
+ # @return [::String]
30
+ # User provided display name of the Execution.
31
+ # May be up to 128 Unicode characters.
32
+ # @!attribute [rw] state
33
+ # @return [::Google::Cloud::AIPlatform::V1::Execution::State]
34
+ # The state of this Execution. This is a property of the Execution, and does
35
+ # not imply or capture any ongoing process. This property is managed by
36
+ # clients (such as Vertex AI Pipelines) and the system does not prescribe
37
+ # or check the validity of state transitions.
38
+ # @!attribute [rw] etag
39
+ # @return [::String]
40
+ # An eTag used to perform consistent read-modify-write updates. If not set, a
41
+ # blind "overwrite" update happens.
42
+ # @!attribute [rw] labels
43
+ # @return [::Google::Protobuf::Map{::String => ::String}]
44
+ # The labels with user-defined metadata to organize your Executions.
45
+ #
46
+ # Label keys and values can be no longer than 64 characters
47
+ # (Unicode codepoints), can only contain lowercase letters, numeric
48
+ # characters, underscores and dashes. International characters are allowed.
49
+ # No more than 64 user labels can be associated with one Execution (System
50
+ # labels are excluded).
51
+ # @!attribute [r] create_time
52
+ # @return [::Google::Protobuf::Timestamp]
53
+ # Output only. Timestamp when this Execution was created.
54
+ # @!attribute [r] update_time
55
+ # @return [::Google::Protobuf::Timestamp]
56
+ # Output only. Timestamp when this Execution was last updated.
57
+ # @!attribute [rw] schema_title
58
+ # @return [::String]
59
+ # The title of the schema describing the metadata.
60
+ #
61
+ # Schema title and version is expected to be registered in earlier Create
62
+ # Schema calls. And both are used together as unique identifiers to identify
63
+ # schemas within the local metadata store.
64
+ # @!attribute [rw] schema_version
65
+ # @return [::String]
66
+ # The version of the schema in `schema_title` to use.
67
+ #
68
+ # Schema title and version is expected to be registered in earlier Create
69
+ # Schema calls. And both are used together as unique identifiers to identify
70
+ # schemas within the local metadata store.
71
+ # @!attribute [rw] metadata
72
+ # @return [::Google::Protobuf::Struct]
73
+ # Properties of the Execution.
74
+ # The size of this field should not exceed 200KB.
75
+ # @!attribute [rw] description
76
+ # @return [::String]
77
+ # Description of the Execution
78
+ class Execution
79
+ include ::Google::Protobuf::MessageExts
80
+ extend ::Google::Protobuf::MessageExts::ClassMethods
81
+
82
+ # @!attribute [rw] key
83
+ # @return [::String]
84
+ # @!attribute [rw] value
85
+ # @return [::String]
86
+ class LabelsEntry
87
+ include ::Google::Protobuf::MessageExts
88
+ extend ::Google::Protobuf::MessageExts::ClassMethods
89
+ end
90
+
91
+ # Describes the state of the Execution.
92
+ module State
93
+ # Unspecified Execution state
94
+ STATE_UNSPECIFIED = 0
95
+
96
+ # The Execution is new
97
+ NEW = 1
98
+
99
+ # The Execution is running
100
+ RUNNING = 2
101
+
102
+ # The Execution has finished running
103
+ COMPLETE = 3
104
+
105
+ # The Execution has failed
106
+ FAILED = 4
107
+
108
+ # The Execution completed through Cache hit.
109
+ CACHED = 5
110
+
111
+ # The Execution was cancelled.
112
+ CANCELLED = 6
113
+ end
114
+ end
115
+ end
116
+ end
117
+ end
118
+ end
@@ -0,0 +1,445 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AIPlatform
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}.
26
+ # @!attribute [r] attributions
27
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::Attribution>]
28
+ # Output only. Feature attributions grouped by predicted outputs.
29
+ #
30
+ # For Models that predict only one output, such as regression Models that
31
+ # predict only one score, there is only one attibution that explains the
32
+ # predicted output. For Models that predict multiple outputs, such as
33
+ # 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.
42
+ class Explanation
43
+ include ::Google::Protobuf::MessageExts
44
+ extend ::Google::Protobuf::MessageExts::ClassMethods
45
+ end
46
+
47
+ # Aggregated explanation metrics for a Model over a set of instances.
48
+ # @!attribute [r] mean_attributions
49
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::Attribution>]
50
+ # Output only. Aggregated attributions explaining the Model's prediction outputs over the
51
+ # set of instances. The attributions are grouped by outputs.
52
+ #
53
+ # For Models that predict only one output, such as regression Models that
54
+ # predict only one score, there is only one attibution that explains the
55
+ # predicted output. For Models that predict multiple outputs, such as
56
+ # multiclass Models that predict multiple classes, each element explains one
57
+ # specific item. {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index} can be used to identify which
58
+ # output this attribution is explaining.
59
+ #
60
+ # The {::Google::Cloud::AIPlatform::V1::Attribution#baseline_output_value baselineOutputValue},
61
+ # {::Google::Cloud::AIPlatform::V1::Attribution#instance_output_value instanceOutputValue} and
62
+ # {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions featureAttributions} fields are
63
+ # averaged over the test data.
64
+ #
65
+ # NOTE: Currently AutoML tabular classification Models produce only one
66
+ # attribution, which averages attributions over all the classes it predicts.
67
+ # {::Google::Cloud::AIPlatform::V1::Attribution#approximation_error Attribution.approximation_error} is not populated.
68
+ class ModelExplanation
69
+ include ::Google::Protobuf::MessageExts
70
+ extend ::Google::Protobuf::MessageExts::ClassMethods
71
+ end
72
+
73
+ # Attribution that explains a particular prediction output.
74
+ # @!attribute [r] baseline_output_value
75
+ # @return [::Float]
76
+ # Output only. Model predicted output if the input instance is constructed from the
77
+ # baselines of all the features defined in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs ExplanationMetadata.inputs}.
78
+ # The field name of the output is determined by the key in
79
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
80
+ #
81
+ # If the Model's predicted output has multiple dimensions (rank > 1), this is
82
+ # the value in the output located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
83
+ #
84
+ # If there are multiple baselines, their output values are averaged.
85
+ # @!attribute [r] instance_output_value
86
+ # @return [::Float]
87
+ # Output only. Model predicted output on the corresponding [explanation
88
+ # instance][ExplainRequest.instances]. The field name of the output is
89
+ # determined by the key in {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
90
+ #
91
+ # If the Model predicted output has multiple dimensions, this is the value in
92
+ # the output located by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}.
93
+ # @!attribute [r] feature_attributions
94
+ # @return [::Google::Protobuf::Value]
95
+ # Output only. Attributions of each explained feature. Features are extracted from
96
+ # the {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances prediction instances} according to
97
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs explanation metadata for inputs}.
98
+ #
99
+ # The value is a struct, whose keys are the name of the feature. The values
100
+ # are how much the feature in the {::Google::Cloud::AIPlatform::V1::ExplainRequest#instances instance}
101
+ # contributed to the predicted result.
102
+ #
103
+ # The format of the value is determined by the feature's input format:
104
+ #
105
+ # * If the feature is a scalar value, the attribution value is a
106
+ # {::Google::Protobuf::Value#number_value floating number}.
107
+ #
108
+ # * If the feature is an array of scalar values, the attribution value is
109
+ # an {::Google::Protobuf::Value#list_value array}.
110
+ #
111
+ # * If the feature is a struct, the attribution value is a
112
+ # {::Google::Protobuf::Value#struct_value struct}. The keys in the
113
+ # attribution value struct are the same as the keys in the feature
114
+ # struct. The formats of the values in the attribution struct are
115
+ # determined by the formats of the values in the feature struct.
116
+ #
117
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#feature_attributions_schema_uri ExplanationMetadata.feature_attributions_schema_uri} field,
118
+ # pointed to by the {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} field of the
119
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#deployed_models Endpoint.deployed_models} object, points to the schema file that
120
+ # describes the features and their attribution values (if it is populated).
121
+ # @!attribute [r] output_index
122
+ # @return [::Array<::Integer>]
123
+ # Output only. The index that locates the explained prediction output.
124
+ #
125
+ # If the prediction output is a scalar value, output_index is not populated.
126
+ # If the prediction output has multiple dimensions, the length of the
127
+ # output_index list is the same as the number of dimensions of the output.
128
+ # The i-th element in output_index is the element index of the i-th dimension
129
+ # of the output vector. Indices start from 0.
130
+ # @!attribute [r] output_display_name
131
+ # @return [::String]
132
+ # Output only. The display name of the output identified by {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index}. For example,
133
+ # the predicted class name by a multi-classification Model.
134
+ #
135
+ # This field is only populated iff the Model predicts display names as a
136
+ # separate field along with the explained output. The predicted display name
137
+ # must has the same shape of the explained output, and can be located using
138
+ # output_index.
139
+ # @!attribute [r] approximation_error
140
+ # @return [::Float]
141
+ # Output only. Error of {::Google::Cloud::AIPlatform::V1::Attribution#feature_attributions feature_attributions} caused by approximation used in the
142
+ # explanation method. Lower value means more precise attributions.
143
+ #
144
+ # * For Sampled Shapley
145
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#sampled_shapley_attribution attribution},
146
+ # increasing {::Google::Cloud::AIPlatform::V1::SampledShapleyAttribution#path_count path_count} might reduce
147
+ # the error.
148
+ # * For Integrated Gradients
149
+ # {::Google::Cloud::AIPlatform::V1::ExplanationParameters#integrated_gradients_attribution attribution},
150
+ # increasing {::Google::Cloud::AIPlatform::V1::IntegratedGradientsAttribution#step_count step_count} might
151
+ # reduce the error.
152
+ # * For {::Google::Cloud::AIPlatform::V1::ExplanationParameters#xrai_attribution XRAI attribution},
153
+ # increasing
154
+ # {::Google::Cloud::AIPlatform::V1::XraiAttribution#step_count step_count} might reduce the error.
155
+ #
156
+ # See [this introduction](/vertex-ai/docs/explainable-ai/overview)
157
+ # for more information.
158
+ # @!attribute [r] output_name
159
+ # @return [::String]
160
+ # Output only. Name of the explain output. Specified as the key in
161
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#outputs ExplanationMetadata.outputs}.
162
+ class Attribution
163
+ include ::Google::Protobuf::MessageExts
164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
165
+ end
166
+
167
+ # Specification of Model explanation.
168
+ # @!attribute [rw] parameters
169
+ # @return [::Google::Cloud::AIPlatform::V1::ExplanationParameters]
170
+ # Required. Parameters that configure explaining of the Model's predictions.
171
+ # @!attribute [rw] metadata
172
+ # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadata]
173
+ # Required. Metadata describing the Model's input and output for explanation.
174
+ class ExplanationSpec
175
+ include ::Google::Protobuf::MessageExts
176
+ extend ::Google::Protobuf::MessageExts::ClassMethods
177
+ end
178
+
179
+ # Parameters to configure explaining for Model's predictions.
180
+ # @!attribute [rw] sampled_shapley_attribution
181
+ # @return [::Google::Cloud::AIPlatform::V1::SampledShapleyAttribution]
182
+ # An attribution method that approximates Shapley values for features that
183
+ # contribute to the label being predicted. A sampling strategy is used to
184
+ # approximate the value rather than considering all subsets of features.
185
+ # Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
186
+ # @!attribute [rw] integrated_gradients_attribution
187
+ # @return [::Google::Cloud::AIPlatform::V1::IntegratedGradientsAttribution]
188
+ # An attribution method that computes Aumann-Shapley values taking
189
+ # advantage of the model's fully differentiable structure. Refer to this
190
+ # paper for more details: https://arxiv.org/abs/1703.01365
191
+ # @!attribute [rw] xrai_attribution
192
+ # @return [::Google::Cloud::AIPlatform::V1::XraiAttribution]
193
+ # An attribution method that redistributes Integrated Gradients
194
+ # attribution to segmented regions, taking advantage of the model's fully
195
+ # differentiable structure. Refer to this paper for
196
+ # more details: https://arxiv.org/abs/1906.02825
197
+ #
198
+ # XRAI currently performs better on natural images, like a picture of a
199
+ # house or an animal. If the images are taken in artificial environments,
200
+ # like a lab or manufacturing line, or from diagnostic equipment, like
201
+ # x-rays or quality-control cameras, use Integrated Gradients instead.
202
+ # @!attribute [rw] top_k
203
+ # @return [::Integer]
204
+ # If populated, returns attributions for top K indices of outputs
205
+ # (defaults to 1). Only applies to Models that predicts more than one outputs
206
+ # (e,g, multi-class Models). When set to -1, returns explanations for all
207
+ # outputs.
208
+ # @!attribute [rw] output_indices
209
+ # @return [::Google::Protobuf::ListValue]
210
+ # If populated, only returns attributions that have
211
+ # {::Google::Cloud::AIPlatform::V1::Attribution#output_index output_index} contained in output_indices. It
212
+ # must be an ndarray of integers, with the same shape of the output it's
213
+ # explaining.
214
+ #
215
+ # If not populated, returns attributions for {::Google::Cloud::AIPlatform::V1::ExplanationParameters#top_k top_k} indices of outputs.
216
+ # If neither top_k nor output_indeices is populated, returns the argmax
217
+ # index of the outputs.
218
+ #
219
+ # Only applicable to Models that predict multiple outputs (e,g, multi-class
220
+ # Models that predict multiple classes).
221
+ class ExplanationParameters
222
+ include ::Google::Protobuf::MessageExts
223
+ extend ::Google::Protobuf::MessageExts::ClassMethods
224
+ end
225
+
226
+ # An attribution method that approximates Shapley values for features that
227
+ # contribute to the label being predicted. A sampling strategy is used to
228
+ # approximate the value rather than considering all subsets of features.
229
+ # @!attribute [rw] path_count
230
+ # @return [::Integer]
231
+ # Required. The number of feature permutations to consider when approximating the
232
+ # Shapley values.
233
+ #
234
+ # Valid range of its value is [1, 50], inclusively.
235
+ class SampledShapleyAttribution
236
+ include ::Google::Protobuf::MessageExts
237
+ extend ::Google::Protobuf::MessageExts::ClassMethods
238
+ end
239
+
240
+ # An attribution method that computes the Aumann-Shapley value taking advantage
241
+ # of the model's fully differentiable structure. Refer to this paper for
242
+ # more details: https://arxiv.org/abs/1703.01365
243
+ # @!attribute [rw] step_count
244
+ # @return [::Integer]
245
+ # Required. The number of steps for approximating the path integral.
246
+ # A good value to start is 50 and gradually increase until the
247
+ # sum to diff property is within the desired error range.
248
+ #
249
+ # Valid range of its value is [1, 100], inclusively.
250
+ # @!attribute [rw] smooth_grad_config
251
+ # @return [::Google::Cloud::AIPlatform::V1::SmoothGradConfig]
252
+ # Config for SmoothGrad approximation of gradients.
253
+ #
254
+ # When enabled, the gradients are approximated by averaging the gradients
255
+ # from noisy samples in the vicinity of the inputs. Adding
256
+ # noise can help improve the computed gradients. Refer to this paper for more
257
+ # details: https://arxiv.org/pdf/1706.03825.pdf
258
+ # @!attribute [rw] blur_baseline_config
259
+ # @return [::Google::Cloud::AIPlatform::V1::BlurBaselineConfig]
260
+ # Config for IG with blur baseline.
261
+ #
262
+ # When enabled, a linear path from the maximally blurred image to the input
263
+ # image is created. Using a blurred baseline instead of zero (black image) is
264
+ # motivated by the BlurIG approach explained here:
265
+ # https://arxiv.org/abs/2004.03383
266
+ class IntegratedGradientsAttribution
267
+ include ::Google::Protobuf::MessageExts
268
+ extend ::Google::Protobuf::MessageExts::ClassMethods
269
+ end
270
+
271
+ # An explanation method that redistributes Integrated Gradients
272
+ # attributions to segmented regions, taking advantage of the model's fully
273
+ # differentiable structure. Refer to this paper for more details:
274
+ # https://arxiv.org/abs/1906.02825
275
+ #
276
+ # Supported only by image Models.
277
+ # @!attribute [rw] step_count
278
+ # @return [::Integer]
279
+ # Required. The number of steps for approximating the path integral.
280
+ # A good value to start is 50 and gradually increase until the
281
+ # sum to diff property is met within the desired error range.
282
+ #
283
+ # Valid range of its value is [1, 100], inclusively.
284
+ # @!attribute [rw] smooth_grad_config
285
+ # @return [::Google::Cloud::AIPlatform::V1::SmoothGradConfig]
286
+ # Config for SmoothGrad approximation of gradients.
287
+ #
288
+ # When enabled, the gradients are approximated by averaging the gradients
289
+ # from noisy samples in the vicinity of the inputs. Adding
290
+ # noise can help improve the computed gradients. Refer to this paper for more
291
+ # details: https://arxiv.org/pdf/1706.03825.pdf
292
+ # @!attribute [rw] blur_baseline_config
293
+ # @return [::Google::Cloud::AIPlatform::V1::BlurBaselineConfig]
294
+ # Config for XRAI with blur baseline.
295
+ #
296
+ # When enabled, a linear path from the maximally blurred image to the input
297
+ # image is created. Using a blurred baseline instead of zero (black image) is
298
+ # motivated by the BlurIG approach explained here:
299
+ # https://arxiv.org/abs/2004.03383
300
+ class XraiAttribution
301
+ include ::Google::Protobuf::MessageExts
302
+ extend ::Google::Protobuf::MessageExts::ClassMethods
303
+ end
304
+
305
+ # Config for SmoothGrad approximation of gradients.
306
+ #
307
+ # When enabled, the gradients are approximated by averaging the gradients from
308
+ # noisy samples in the vicinity of the inputs. Adding noise can help improve
309
+ # the computed gradients. Refer to this paper for more details:
310
+ # https://arxiv.org/pdf/1706.03825.pdf
311
+ # @!attribute [rw] noise_sigma
312
+ # @return [::Float]
313
+ # This is a single float value and will be used to add noise to all the
314
+ # features. Use this field when all features are normalized to have the
315
+ # same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where
316
+ # features are normalized to have 0-mean and 1-variance. Learn more about
317
+ # [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization).
318
+ #
319
+ # For best results the recommended value is about 10% - 20% of the standard
320
+ # deviation of the input feature. Refer to section 3.2 of the SmoothGrad
321
+ # paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.
322
+ #
323
+ # If the distribution is different per feature, set
324
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#feature_noise_sigma feature_noise_sigma} instead
325
+ # for each feature.
326
+ # @!attribute [rw] feature_noise_sigma
327
+ # @return [::Google::Cloud::AIPlatform::V1::FeatureNoiseSigma]
328
+ # This is similar to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}, but
329
+ # provides additional flexibility. A separate noise sigma can be provided
330
+ # for each feature, which is useful if their distributions are different.
331
+ # No noise is added to features that are not set. If this field is unset,
332
+ # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma} will be used for all
333
+ # features.
334
+ # @!attribute [rw] noisy_sample_count
335
+ # @return [::Integer]
336
+ # The number of gradient samples to use for
337
+ # approximation. The higher this number, the more accurate the gradient
338
+ # is, but the runtime complexity increases by this factor as well.
339
+ # Valid range of its value is [1, 50]. Defaults to 3.
340
+ class SmoothGradConfig
341
+ include ::Google::Protobuf::MessageExts
342
+ extend ::Google::Protobuf::MessageExts::ClassMethods
343
+ end
344
+
345
+ # Noise sigma by features. Noise sigma represents the standard deviation of the
346
+ # gaussian kernel that will be used to add noise to interpolated inputs prior
347
+ # to computing gradients.
348
+ # @!attribute [rw] noise_sigma
349
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::FeatureNoiseSigma::NoiseSigmaForFeature>]
350
+ # Noise sigma per feature. No noise is added to features that are not set.
351
+ class FeatureNoiseSigma
352
+ include ::Google::Protobuf::MessageExts
353
+ extend ::Google::Protobuf::MessageExts::ClassMethods
354
+
355
+ # Noise sigma for a single feature.
356
+ # @!attribute [rw] name
357
+ # @return [::String]
358
+ # The name of the input feature for which noise sigma is provided. The
359
+ # features are defined in
360
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs explanation metadata inputs}.
361
+ # @!attribute [rw] sigma
362
+ # @return [::Float]
363
+ # This represents the standard deviation of the Gaussian kernel that will
364
+ # be used to add noise to the feature prior to computing gradients. Similar
365
+ # to {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma} but represents the
366
+ # noise added to the current feature. Defaults to 0.1.
367
+ class NoiseSigmaForFeature
368
+ include ::Google::Protobuf::MessageExts
369
+ extend ::Google::Protobuf::MessageExts::ClassMethods
370
+ end
371
+ end
372
+
373
+ # Config for blur baseline.
374
+ #
375
+ # When enabled, a linear path from the maximally blurred image to the input
376
+ # image is created. Using a blurred baseline instead of zero (black image) is
377
+ # motivated by the BlurIG approach explained here:
378
+ # https://arxiv.org/abs/2004.03383
379
+ # @!attribute [rw] max_blur_sigma
380
+ # @return [::Float]
381
+ # The standard deviation of the blur kernel for the blurred baseline. The
382
+ # same blurring parameter is used for both the height and the width
383
+ # dimension. If not set, the method defaults to the zero (i.e. black for
384
+ # images) baseline.
385
+ class BlurBaselineConfig
386
+ include ::Google::Protobuf::MessageExts
387
+ extend ::Google::Protobuf::MessageExts::ClassMethods
388
+ end
389
+
390
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} entries that can be overridden at
391
+ # {::Google::Cloud::AIPlatform::V1::PredictionService::Client#explain online explanation} time.
392
+ # @!attribute [rw] parameters
393
+ # @return [::Google::Cloud::AIPlatform::V1::ExplanationParameters]
394
+ # The parameters to be overridden. Note that the
395
+ # [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be changed. If not specified,
396
+ # no parameter is overridden.
397
+ # @!attribute [rw] metadata
398
+ # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride]
399
+ # The metadata to be overridden. If not specified, no metadata is overridden.
400
+ class ExplanationSpecOverride
401
+ include ::Google::Protobuf::MessageExts
402
+ extend ::Google::Protobuf::MessageExts::ClassMethods
403
+ end
404
+
405
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata ExplanationMetadata} entries that can be overridden at
406
+ # {::Google::Cloud::AIPlatform::V1::PredictionService::Client#explain online explanation} time.
407
+ # @!attribute [rw] inputs
408
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride::InputMetadataOverride}]
409
+ # Required. Overrides the {::Google::Cloud::AIPlatform::V1::ExplanationMetadata#inputs input metadata} of the features.
410
+ # The key is the name of the feature to be overridden. The keys specified
411
+ # here must exist in the input metadata to be overridden. If a feature is
412
+ # not specified here, the corresponding feature's input metadata is not
413
+ # overridden.
414
+ class ExplanationMetadataOverride
415
+ include ::Google::Protobuf::MessageExts
416
+ extend ::Google::Protobuf::MessageExts::ClassMethods
417
+
418
+ # The {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata input metadata} entries to be
419
+ # overridden.
420
+ # @!attribute [rw] input_baselines
421
+ # @return [::Array<::Google::Protobuf::Value>]
422
+ # Baseline inputs for this feature.
423
+ #
424
+ # This overrides the `input_baseline` field of the
425
+ # {::Google::Cloud::AIPlatform::V1::ExplanationMetadata::InputMetadata ExplanationMetadata.InputMetadata}
426
+ # object of the corresponding feature's input metadata. If it's not
427
+ # specified, the original baselines are not overridden.
428
+ class InputMetadataOverride
429
+ include ::Google::Protobuf::MessageExts
430
+ extend ::Google::Protobuf::MessageExts::ClassMethods
431
+ end
432
+
433
+ # @!attribute [rw] key
434
+ # @return [::String]
435
+ # @!attribute [rw] value
436
+ # @return [::Google::Cloud::AIPlatform::V1::ExplanationMetadataOverride::InputMetadataOverride]
437
+ class InputsEntry
438
+ include ::Google::Protobuf::MessageExts
439
+ extend ::Google::Protobuf::MessageExts::ClassMethods
440
+ end
441
+ end
442
+ end
443
+ end
444
+ end
445
+ end