From e3b6b7f1bdb9ec8746cf8339e2a9fc1ecef19d93 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 24 May 2021 14:41:52 -0700 Subject: [PATCH] docs: removes tinyurl links (#138) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: removes tinyurl links PiperOrigin-RevId: 375484379 Source-Link: https://github.com/googleapis/googleapis/commit/f465a6dfa999f996d2c13d109dfc55cba86f790e Source-Link: https://github.com/googleapis/googleapis-gen/commit/43c44257a703d43b5b36332a00e2ef1c9ff36795 * 🦉 Updates from OwlBot Co-authored-by: Owl Bot --- .../cloud/aiplatform/v1/annotation.proto | 6 +- .../cloud/aiplatform/v1/annotation_spec.proto | 2 +- .../aiplatform/v1/batch_prediction_job.proto | 11 +- .../aiplatform/v1/completion_stats.proto | 2 +- .../cloud/aiplatform/v1/custom_job.proto | 21 +- .../cloud/aiplatform/v1/data_item.proto | 2 +- .../aiplatform/v1/data_labeling_job.proto | 8 +- .../google/cloud/aiplatform/v1/dataset.proto | 5 +- .../cloud/aiplatform/v1/dataset_service.proto | 7 +- .../aiplatform/v1/deployed_model_ref.proto | 2 +- .../cloud/aiplatform/v1/encryption_spec.proto | 2 +- .../google/cloud/aiplatform/v1/endpoint.proto | 2 +- .../aiplatform/v1/endpoint_service.proto | 6 +- .../google/cloud/aiplatform/v1/env_var.proto | 2 +- .../v1/hyperparameter_tuning_job.proto | 4 +- .../google/cloud/aiplatform/v1/io.proto | 8 +- .../cloud/aiplatform/v1/job_service.proto | 23 +- .../cloud/aiplatform/v1/job_state.proto | 2 +- .../aiplatform/v1/machine_resources.proto | 19 +- .../v1/manual_batch_tuning_parameters.proto | 2 +- .../aiplatform/v1/migratable_resource.proto | 8 +- .../aiplatform/v1/migration_service.proto | 62 +- .../google/cloud/aiplatform/v1/model.proto | 132 +- .../aiplatform/v1/model_evaluation.proto | 6 +- .../v1/model_evaluation_slice.proto | 6 +- .../cloud/aiplatform/v1/model_service.proto | 12 +- .../cloud/aiplatform/v1/operation.proto | 2 +- .../aiplatform/v1/pipeline_service.proto | 9 +- .../cloud/aiplatform/v1/pipeline_state.proto | 6 +- .../aiplatform/v1/prediction_service.proto | 2 +- .../cloud/aiplatform/v1/specialist_pool.proto | 2 +- .../v1/specialist_pool_service.proto | 4 +- .../google/cloud/aiplatform/v1/study.proto | 12 +- .../aiplatform/v1/training_pipeline.proto | 29 +- .../aiplatform/v1/user_action_reference.proto | 7 +- .../cloud/aiplatform/v1beta1/annotation.proto | 4 +- .../cloud/aiplatform/v1beta1/artifact.proto | 4 +- .../v1beta1/batch_prediction_job.proto | 4 +- .../cloud/aiplatform/v1beta1/custom_job.proto | 13 +- .../cloud/aiplatform/v1beta1/dataset.proto | 3 +- .../aiplatform/v1beta1/dataset_service.proto | 3 +- .../aiplatform/v1beta1/endpoint_service.proto | 4 +- .../cloud/aiplatform/v1beta1/execution.proto | 4 +- .../aiplatform/v1beta1/explanation.proto | 7 +- .../v1beta1/explanation_metadata.proto | 24 +- .../v1beta1/feature_monitoring_stats.proto | 2 +- .../v1beta1/featurestore_service.proto | 4 - .../v1beta1/hyperparameter_tuning_job.proto | 2 +- .../cloud/aiplatform/v1beta1/index.proto | 4 +- .../aiplatform/v1beta1/index_endpoint.proto | 2 +- .../v1beta1/index_endpoint_service.proto | 6 +- .../aiplatform/v1beta1/index_service.proto | 5 +- .../aiplatform/v1beta1/job_service.proto | 2 +- .../v1beta1/machine_resources.proto | 17 +- .../aiplatform/v1beta1/metadata_schema.proto | 5 +- .../aiplatform/v1beta1/metadata_service.proto | 159 +- .../aiplatform/v1beta1/metadata_store.proto | 8 +- .../v1beta1/migration_service.proto | 38 +- .../cloud/aiplatform/v1beta1/model.proto | 128 +- .../model_deployment_monitoring_job.proto | 2 +- .../aiplatform/v1beta1/model_evaluation.proto | 4 +- .../v1beta1/model_evaluation_slice.proto | 4 +- .../aiplatform/v1beta1/model_service.proto | 7 +- .../aiplatform/v1beta1/pipeline_job.proto | 9 +- .../aiplatform/v1beta1/pipeline_service.proto | 20 +- .../aiplatform/v1beta1/pipeline_state.proto | 4 +- .../prediction/time_series_forecasting.proto | 8 +- .../automl_time_series_forecasting.proto | 217 +- .../cloud/aiplatform/v1beta1/study.proto | 10 +- .../v1beta1/training_pipeline.proto | 22 +- .../aiplatform/v1beta1/vizier_service.proto | 4 +- .../protos/protos.d.ts | 1131 +++++++ .../google-cloud-aiplatform/protos/protos.js | 2802 +++++++++++++++++ .../protos/protos.json | 196 ++ .../src/v1/dataset_service_client.ts | 7 +- .../src/v1/endpoint_service_client.ts | 4 +- .../src/v1/job_service_client.ts | 17 +- .../src/v1/migration_service_client.ts | 75 +- .../src/v1/model_service_client.ts | 12 +- .../src/v1/pipeline_service_client.ts | 7 +- .../src/v1/specialist_pool_service_client.ts | 1 - .../src/v1beta1/dataset_service_client.ts | 3 +- .../v1beta1/dataset_service_proto_list.json | 2 + .../src/v1beta1/endpoint_service_client.ts | 4 +- .../v1beta1/endpoint_service_proto_list.json | 2 + ...ore_online_serving_service_proto_list.json | 2 + .../v1beta1/featurestore_service_client.ts | 8 - .../featurestore_service_proto_list.json | 2 + .../v1beta1/index_endpoint_service_client.ts | 6 +- .../index_endpoint_service_proto_list.json | 2 + .../src/v1beta1/index_service_client.ts | 5 +- .../src/v1beta1/index_service_proto_list.json | 2 + .../src/v1beta1/job_service_client.ts | 2 +- .../src/v1beta1/job_service_proto_list.json | 2 + .../src/v1beta1/metadata_service_client.ts | 397 ++- .../v1beta1/metadata_service_proto_list.json | 2 + .../src/v1beta1/migration_service_client.ts | 12 +- .../v1beta1/migration_service_proto_list.json | 2 + .../src/v1beta1/model_service_client.ts | 7 +- .../src/v1beta1/model_service_proto_list.json | 2 + .../src/v1beta1/pipeline_service_client.ts | 52 +- .../v1beta1/pipeline_service_proto_list.json | 2 + .../prediction_service_proto_list.json | 2 + .../specialist_pool_service_proto_list.json | 2 + .../tensorboard_service_proto_list.json | 2 + .../src/v1beta1/vizier_service_client.ts | 4 +- .../v1beta1/vizier_service_proto_list.json | 2 + 107 files changed, 5115 insertions(+), 865 deletions(-) diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto index 14e6c6b837c..545cf2786d4 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -40,8 +40,8 @@ message Annotation { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1.Annotation.payload]. The - // schema is defined as an - // [OpenAPI 3.0.2 Schema Object](https://tinyurl.com/y538mdwt). + // schema is defined as an [OpenAPI 3.0.2 Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // The schema files that can be used here are found in // gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the // chosen schema must be consistent with the parent Dataset's diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto index d087278a1d2..bbcb0326692 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto index dab242c3d07..f99371b2347 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -96,8 +96,8 @@ message BatchPredictionJob { // containing only `code` and `message` fields. GcsDestination gcs_destination = 2; - // The BigQuery project location where the output is to be written to. - // In the given project a new dataset is created with name + // The BigQuery project or dataset location where the output is to be + // written to. If project is provided, a new dataset is created with name // `prediction__` // where is made // BigQuery-dataset-name compatible (for example, most special characters @@ -117,9 +117,8 @@ message BatchPredictionJob { BigQueryDestination bigquery_destination = 3; } - // Required. The format in which AI Platform gives the predictions, must be one of the + // Required. The format in which Vertex AI gives the predictions, must be one of the // [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] - // // [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. string predictions_format = 1 [(google.api.field_behavior) = REQUIRED]; } @@ -188,7 +187,7 @@ message BatchPredictionJob { BatchDedicatedResources dedicated_resources = 7; // Immutable. Parameters configuring the batch behavior. Currently only applicable when - // [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] are used (in other cases AI Platform does + // [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does // the tuning itself). ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(google.api.field_behavior) = IMMUTABLE]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto index 2e37bcc477e..56dddbad7d4 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto index eb9125ad72a..fd66585e418 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -93,6 +93,8 @@ message CustomJob { // Represents the spec of a CustomJob. message CustomJobSpec { // Required. The spec of the worker pools including machine type and Docker image. + // All worker pools except the first one are optional and can be skipped by + // providing an empty value. repeated WorkerPoolSpec worker_pool_specs = 1 [(google.api.field_behavior) = REQUIRED]; // Scheduling options for a CustomJob. @@ -100,8 +102,9 @@ message CustomJobSpec { // Specifies the service account for workload run-as account. // Users submitting jobs must have act-as permission on this run-as account. - // If unspecified, the AI Platform Custom Code Service Agent for the - // CustomJob's project is used. + // If unspecified, the [AI Platform Custom Code Service + // Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + // for the CustomJob's project is used. string service_account = 4; // The full name of the Compute Engine @@ -123,7 +126,7 @@ message CustomJobSpec { // [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's // baseOutputDirectory. // - // The following AI Platform environment variables will be passed to + // The following Vertex AI environment variables will be passed to // containers or python modules when this field is set: // // For CustomJob: @@ -183,10 +186,12 @@ message ContainerSpec { // The spec of a Python packaged code. message PythonPackageSpec { - // Required. The URI of a container image in the Container Registry that will run the - // provided python package. AI Platform provides wide range of executor images - // with pre-installed packages to meet users' various use cases. Only one of - // the provided images can be set here. + // Required. The URI of a container image in Artifact Registry that will run the + // provided Python package. Vertex AI provides a wide range of executor + // images with pre-installed packages to meet users' various use cases. See + // the list of [pre-built containers for + // training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + // You must use an image from this list. string executor_image_uri = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The Google Cloud Storage location of the Python package files which are diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto index fdc2e5bdcee..399de0e8a05 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto index c6af3826251..a95f27c3b07 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -134,9 +134,9 @@ message DataLabelingJob { // the EncryptionSpec of the Dataset they are exported to. EncryptionSpec encryption_spec = 20; - // Parameters that configure the active learning pipeline. Active learning will - // label the data incrementally via several iterations. For every iteration, - // it will select a batch of data based on the sampling strategy. + // Parameters that configure the active learning pipeline. Active learning + // will label the data incrementally via several iterations. For every + // iteration, it will select a batch of data based on the sampling strategy. ActiveLearningConfig active_learning_config = 21; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto index 7aabab48664..e970c8cf222 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -109,7 +109,8 @@ message ImportDataConfig { // Required. Points to a YAML file stored on Google Cloud Storage describing the import // format. Validation will be done against the schema. The schema is defined - // as an [OpenAPI 3.0.2 Schema Object](https://tinyurl.com/y538mdwt). + // as an [OpenAPI 3.0.2 Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string import_schema_uri = 4 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto index 8c6ea31fe23..75a71664cde 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -180,8 +180,7 @@ message UpdateDatasetRequest { Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - // For the `FieldMask` definition, see - // [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask). + // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. // Updatable fields: // // * `display_name` @@ -358,7 +357,6 @@ message ListDataItemsResponse { message GetAnnotationSpecRequest { // Required. The name of the AnnotationSpec resource. // Format: - // // `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -375,7 +373,6 @@ message GetAnnotationSpecRequest { message ListAnnotationsRequest { // Required. The resource name of the DataItem to list Annotations from. // Format: - // // `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/deployed_model_ref.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/deployed_model_ref.proto index f3e6184c814..c0a954e0e40 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/deployed_model_ref.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/deployed_model_ref.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto index dd97fb48b8b..36e2578e96e 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto index 3b9afe32fbf..7c5277e4338 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto index f055c605179..ca3352f544c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -212,9 +212,7 @@ message UpdateEndpointRequest { // Required. The Endpoint which replaces the resource on the server. Endpoint endpoint = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. - // See - // [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask). + // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask]. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/env_var.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/env_var.proto index 8071a70de53..9bb71f6b5ae 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/env_var.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/env_var.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto index 2f3a1011dd7..f1c3990b77c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -60,7 +60,7 @@ message HyperparameterTuningJob { // The number of failed Trials that need to be seen before failing // the HyperparameterTuningJob. // - // If set to 0, AI Platform decides how many Trials must fail + // If set to 0, Vertex AI decides how many Trials must fail // before the whole job fails. int32 max_failed_trial_count = 7; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto index c32c66e7962..6df4ac56840 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -53,9 +53,9 @@ message BigQuerySource { message BigQueryDestination { // Required. BigQuery URI to a project or table, up to 2000 characters long. // - // When only the project is specified, the Dataset and Table are created. - // When the full table reference is specified, the Dataset must exist and table must - // not exist. + // When only the project is specified, the Dataset and Table is created. + // When the full table reference is specified, the Dataset must exist and + // table must not exist. // // Accepted forms: // diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto index b9bff3d3e74..0bbee54b8a0 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -35,7 +35,7 @@ option java_multiple_files = true; option java_outer_classname = "JobServiceProto"; option java_package = "com.google.cloud.aiplatform.v1"; -// A service for creating and managing AI Platform's jobs. +// A service for creating and managing Vertex AI's jobs. service JobService { option (google.api.default_host) = "aiplatform.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; @@ -362,7 +362,7 @@ message CancelCustomJobRequest { ]; } -// Request message for [DataLabelingJobService.CreateDataLabelingJob][]. +// Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob]. message CreateDataLabelingJobRequest { // Required. The parent of the DataLabelingJob. // Format: `projects/{project}/locations/{location}` @@ -377,11 +377,10 @@ message CreateDataLabelingJobRequest { DataLabelingJob data_labeling_job = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [DataLabelingJobService.GetDataLabelingJob][]. +// Request message for [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob]. message GetDataLabelingJobRequest { // Required. The name of the DataLabelingJob. // Format: - // // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -391,7 +390,7 @@ message GetDataLabelingJobRequest { ]; } -// Request message for [DataLabelingJobService.ListDataLabelingJobs][]. +// Request message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs]. message ListDataLabelingJobsRequest { // Required. The parent of the DataLabelingJob. // Format: `projects/{project}/locations/{location}` @@ -453,7 +452,6 @@ message ListDataLabelingJobsResponse { message DeleteDataLabelingJobRequest { // Required. The name of the DataLabelingJob to be deleted. // Format: - // // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -463,11 +461,10 @@ message DeleteDataLabelingJobRequest { ]; } -// Request message for [DataLabelingJobService.CancelDataLabelingJob][]. +// Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob]. message CancelDataLabelingJobRequest { // Required. The name of the DataLabelingJob. // Format: - // // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -496,7 +493,6 @@ message CreateHyperparameterTuningJobRequest { message GetHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob resource. // Format: - // // `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -565,7 +561,6 @@ message ListHyperparameterTuningJobsResponse { message DeleteHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob resource to be deleted. // Format: - // // `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -579,7 +574,6 @@ message DeleteHyperparameterTuningJobRequest { message CancelHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob to cancel. // Format: - // // `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -608,7 +602,6 @@ message CreateBatchPredictionJobRequest { message GetBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob resource. // Format: - // // `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -637,6 +630,8 @@ message ListBatchPredictionJobsRequest { // // * `state` supports = and !=. // + // * `model_display_name` supports = and != + // // Some examples of using the filter are: // // * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"` @@ -676,7 +671,6 @@ message ListBatchPredictionJobsResponse { message DeleteBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob resource to be deleted. // Format: - // // `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -690,7 +684,6 @@ message DeleteBatchPredictionJobRequest { message CancelBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob to cancel. // Format: - // // `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` string name = 1 [ (google.api.field_behavior) = REQUIRED, diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_state.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_state.proto index e0a600a8bda..18504390f4f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_state.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_state.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto index f10cd4e1d6b..4bf84df8ef6 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -27,10 +27,13 @@ option java_package = "com.google.cloud.aiplatform.v1"; // Specification of a single machine. message MachineSpec { - // Immutable. The type of the machine. For the machine types supported for prediction, - // see https://tinyurl.com/aip-docs/predictions/machine-types. - // For machine types supported for creating a custom training job, see - // https://tinyurl.com/aip-docs/training/configure-compute. + // Immutable. The type of the machine. + // + // See the [list of machine types supported for + // prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) + // + // See the [list of machine types supported for custom + // training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). // // For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is optional, and the default // value is `n1-standard-2`. For [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as part of @@ -77,7 +80,7 @@ message DedicatedResources { int32 max_replica_count = 3 [(google.api.field_behavior) = IMMUTABLE]; } -// A description of resources that to large degree are decided by AI Platform, +// A description of resources that to large degree are decided by Vertex AI, // and require only a modest additional configuration. // Each Model supporting these resources documents its specific guidelines. message AutomaticResources { @@ -95,7 +98,7 @@ message AutomaticResources { // outages). If traffic against the DeployedModel increases beyond what its // replicas at maximum may handle, a portion of the traffic will be dropped. // If this value is not provided, a no upper bound for scaling under heavy - // traffic will be assume, though AI Platform may be unable to scale beyond + // traffic will be assume, though Vertex AI may be unable to scale beyond // certain replica number. int32 max_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE]; } @@ -110,7 +113,7 @@ message BatchDedicatedResources { ]; // Immutable. The number of machine replicas used at the start of the batch operation. - // If not set, AI Platform decides starting number, not greater than + // If not set, Vertex AI decides starting number, not greater than // [max_replica_count][google.cloud.aiplatform.v1.BatchDedicatedResources.max_replica_count] int32 starting_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto index da258a7bc62..0266b286ea7 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto index 9e126901b4d..ca2918cff04 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -100,7 +100,6 @@ message MigratableResource { message DataLabelingAnnotatedDataset { // Full resource name of data labeling AnnotatedDataset. // Format: - // // `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. string annotated_dataset = 1 [(google.api.resource_reference) = { type: "datalabeling.googleapis.com/AnnotatedDataset" @@ -139,8 +138,9 @@ message MigratableResource { DataLabelingDataset data_labeling_dataset = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Output only. Timestamp when the last migration attempt on this MigratableResource started. - // Will not be set if there's no migration attempt on this MigratableResource. + // Output only. Timestamp when the last migration attempt on this MigratableResource + // started. Will not be set if there's no migration attempt on this + // MigratableResource. google.protobuf.Timestamp last_migrate_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this MigratableResource was last updated. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto index 353bcd61988..ccdbe39a4be 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -33,14 +33,14 @@ option java_outer_classname = "MigrationServiceProto"; option java_package = "com.google.cloud.aiplatform.v1"; // A service that migrates resources from automl.googleapis.com, -// datalabeling.googleapis.com and ml.googleapis.com to AI Platform. +// datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. service MigrationService { option (google.api.default_host) = "aiplatform.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; // Searches all of the resources in automl.googleapis.com, // datalabeling.googleapis.com and ml.googleapis.com that can be migrated to - // AI Platform's given location. + // Vertex AI's given location. rpc SearchMigratableResources(SearchMigratableResourcesRequest) returns (SearchMigratableResourcesResponse) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/migratableResources:search" @@ -50,7 +50,7 @@ service MigrationService { } // Batch migrates resources from ml.googleapis.com, automl.googleapis.com, - // and datalabeling.googleapis.com to AI Platform (Unified). + // and datalabeling.googleapis.com to Vertex AI. rpc BatchMigrateResources(BatchMigrateResourcesRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/migratableResources:batchMigrate" @@ -67,7 +67,7 @@ service MigrationService { // Request message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources]. message SearchMigratableResourcesRequest { // Required. The location that the migratable resources should be searched from. - // It's the AI Platform location that the resources can be migrated to, not + // It's the Vertex AI location that the resources can be migrated to, not // the resources' original location. // Format: // `projects/{project}/locations/{location}` @@ -85,15 +85,18 @@ message SearchMigratableResourcesRequest { // The standard page token. string page_token = 3; - // Supported filters are: - // * Resource type: For a specific type of MigratableResource. - // * `ml_engine_model_version:*` - // * `automl_model:*`, - // * `automl_dataset:*` - // * `data_labeling_dataset:*`. - // * Migrated or not: Filter migrated resource or not by last_migrate_time. - // * `last_migrate_time:*` will filter migrated resources. - // * `NOT last_migrate_time:*` will filter not yet migrated resources. + // A filter for your search. You can use the following types of filters: + // + // * Resource type filters. The following strings filter for a specific type + // of [MigratableResource][google.cloud.aiplatform.v1.MigratableResource]: + // * `ml_engine_model_version:*` + // * `automl_model:*` + // * `automl_dataset:*` + // * `data_labeling_dataset:*` + // * "Migrated or not" filters. The following strings filter for resources + // that either have or have not already been migrated: + // * `last_migrate_time:*` filters for migrated resources. + // * `NOT last_migrate_time:*` filters for not yet migrated resources. string filter = 4; } @@ -127,9 +130,9 @@ message BatchMigrateResourcesRequest { } // Config of migrating one resource from automl.googleapis.com, -// datalabeling.googleapis.com and ml.googleapis.com to AI Platform. +// datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. message MigrateResourceRequest { - // Config for migrating version in ml.googleapis.com to AI Platform's Model. + // Config for migrating version in ml.googleapis.com to Vertex AI's Model. message MigrateMlEngineModelVersionConfig { // Required. The ml.googleapis.com endpoint that this model version should be migrated // from. @@ -153,12 +156,12 @@ message MigrateResourceRequest { } ]; - // Required. Display name of the model in AI Platform. + // Required. Display name of the model in Vertex AI. // System will pick a display name if unspecified. string model_display_name = 3 [(google.api.field_behavior) = REQUIRED]; } - // Config for migrating Model in automl.googleapis.com to AI Platform's Model. + // Config for migrating Model in automl.googleapis.com to Vertex AI's Model. message MigrateAutomlModelConfig { // Required. Full resource name of automl Model. // Format: @@ -170,12 +173,12 @@ message MigrateResourceRequest { } ]; - // Optional. Display name of the model in AI Platform. + // Optional. Display name of the model in Vertex AI. // System will pick a display name if unspecified. string model_display_name = 2 [(google.api.field_behavior) = OPTIONAL]; } - // Config for migrating Dataset in automl.googleapis.com to AI Platform's + // Config for migrating Dataset in automl.googleapis.com to Vertex AI's // Dataset. message MigrateAutomlDatasetConfig { // Required. Full resource name of automl Dataset. @@ -188,7 +191,7 @@ message MigrateResourceRequest { } ]; - // Required. Display name of the Dataset in AI Platform. + // Required. Display name of the Dataset in Vertex AI. // System will pick a display name if unspecified. string dataset_display_name = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -197,11 +200,10 @@ message MigrateResourceRequest { // Platform's Dataset. message MigrateDataLabelingDatasetConfig { // Config for migrating AnnotatedDataset in datalabeling.googleapis.com to - // AI Platform's SavedQuery. + // Vertex AI's SavedQuery. message MigrateDataLabelingAnnotatedDatasetConfig { // Required. Full resource name of data labeling AnnotatedDataset. // Format: - // // `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. string annotated_dataset = 1 [ (google.api.field_behavior) = REQUIRED, @@ -221,30 +223,30 @@ message MigrateResourceRequest { } ]; - // Optional. Display name of the Dataset in AI Platform. + // Optional. Display name of the Dataset in Vertex AI. // System will pick a display name if unspecified. string dataset_display_name = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. Configs for migrating AnnotatedDataset in datalabeling.googleapis.com to - // AI Platform's SavedQuery. The specified AnnotatedDatasets have to belong + // Vertex AI's SavedQuery. The specified AnnotatedDatasets have to belong // to the datalabeling Dataset. repeated MigrateDataLabelingAnnotatedDatasetConfig migrate_data_labeling_annotated_dataset_configs = 3 [(google.api.field_behavior) = OPTIONAL]; } oneof request { - // Config for migrating Version in ml.googleapis.com to AI Platform's Model. + // Config for migrating Version in ml.googleapis.com to Vertex AI's Model. MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config = 1; - // Config for migrating Model in automl.googleapis.com to AI Platform's + // Config for migrating Model in automl.googleapis.com to Vertex AI's // Model. MigrateAutomlModelConfig migrate_automl_model_config = 2; - // Config for migrating Dataset in automl.googleapis.com to AI Platform's + // Config for migrating Dataset in automl.googleapis.com to Vertex AI's // Dataset. MigrateAutomlDatasetConfig migrate_automl_dataset_config = 3; // Config for migrating Dataset in datalabeling.googleapis.com to - // AI Platform's Dataset. + // Vertex AI's Dataset. MigrateDataLabelingDatasetConfig migrate_data_labeling_dataset_config = 4; } } @@ -257,7 +259,7 @@ message BatchMigrateResourcesResponse { // Describes a successfully migrated resource. message MigrateResourceResponse { - // After migration, the resource name in AI Platform. + // After migration, the resource name in Vertex AI. oneof migrated_resource { // Migrated Dataset's resource name. string dataset = 1 [(google.api.resource_reference) = { diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto index cf003c645a7..1b8bcf5f9f0 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -93,7 +93,7 @@ message Model { // higher degree of manual configuration. DEDICATED_RESOURCES = 1; - // Resources that to large degree are decided by AI Platform, and require + // Resources that to large degree are decided by Vertex AI, and require // only a modest additional configuration. AUTOMATIC_RESOURCES = 2; } @@ -117,9 +117,9 @@ message Model { // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional // information about the Model, that is specific to it. Unset if the Model // does not have any additional information. - // The schema is defined as an OpenAPI 3.0.2 - // [Schema Object](https://tinyurl.com/y538mdwt#schema-object). - // AutoML Models always have this field populated by AI Platform, if no + // The schema is defined as an OpenAPI 3.0.2 [Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + // AutoML Models always have this field populated by Vertex AI, if no // additional metadata is needed, this field is set to an empty string. // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will @@ -146,7 +146,7 @@ message Model { // Input only. The specification of the container that is to be used when deploying // this Model. The specification is ingested upon // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], and all binaries it contains are copied - // and stored internally by AI Platform. + // and stored internally by Vertex AI. // Not present for AutoML Models. ModelContainerSpec container_spec = 9 [(google.api.field_behavior) = INPUT_ONLY]; @@ -242,7 +242,7 @@ message Model { // [PredictionService.Explain][]. repeated string supported_output_storage_formats = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Timestamp when this Model was uploaded into AI Platform. + // Output only. Timestamp when this Model was uploaded into Vertex AI. google.protobuf.Timestamp create_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Model was most recently updated. @@ -278,9 +278,9 @@ message PredictSchemata { // of a single instance, which are used in [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances], // [ExplainRequest.instances][] and // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. - // The schema is defined as an OpenAPI 3.0.2 - // [Schema Object](https://tinyurl.com/y538mdwt#schema-object). - // AutoML Models always have this field populated by AI Platform. + // The schema is defined as an OpenAPI 3.0.2 [Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + // AutoML Models always have this field populated by Vertex AI. // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will // point to a location where the user only has a read access. @@ -290,9 +290,9 @@ message PredictSchemata { // parameters of prediction and explanation via // [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters], [ExplainRequest.parameters][] and // [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters]. - // The schema is defined as an OpenAPI 3.0.2 - // [Schema Object](https://tinyurl.com/y538mdwt#schema-object). - // AutoML Models always have this field populated by AI Platform, if no + // The schema is defined as an OpenAPI 3.0.2 [Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + // AutoML Models always have this field populated by Vertex AI, if no // parameters are supported, then it is set to an empty string. // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will @@ -303,31 +303,35 @@ message PredictSchemata { // of a single prediction produced by this Model, which are returned via // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions], [ExplainResponse.explanations][], and // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. - // The schema is defined as an OpenAPI 3.0.2 - // [Schema Object](https://tinyurl.com/y538mdwt#schema-object). - // AutoML Models always have this field populated by AI Platform. + // The schema is defined as an OpenAPI 3.0.2 [Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + // AutoML Models always have this field populated by Vertex AI. // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will // point to a location where the user only has a read access. string prediction_schema_uri = 3 [(google.api.field_behavior) = IMMUTABLE]; } -// Specification of a container for serving predictions. This message is a -// subset of the Kubernetes Container v1 core -// [specification](https://tinyurl.com/k8s-io-api/v1.18/#container-v1-core). +// Specification of a container for serving predictions. Some fields in this +// message correspond to fields in the [Kubernetes Container v1 core +// specification](https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). message ModelContainerSpec { // Required. Immutable. URI of the Docker image to be used as the custom container for serving // predictions. This URI must identify an image in Artifact Registry or - // Container Registry. Learn more about the container publishing - // requirements, including permissions requirements for the AI Platform - // Service Agent, - // [here](https://tinyurl.com/cust-cont-reqs#publishing). + // Container Registry. Learn more about the [container publishing + // requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), + // including permissions requirements for the AI Platform Service Agent. // // The container image is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], stored // internally, and this original path is afterwards not used. // // To learn about the requirements for the Docker image itself, see - // [Custom container requirements](https://tinyurl.com/cust-cont-reqs). + // [Custom container + // requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). + // + // You can use the URI to one of Vertex AI's [pre-built container images for + // prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) + // in this field. string image_uri = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE @@ -343,19 +347,19 @@ message ModelContainerSpec { // in conjunction with the [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] field or the // container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), // if either exists. If this field is not specified and the container does not - // have an `ENTRYPOINT`, then refer to the Docker documentation about how + // have an `ENTRYPOINT`, then refer to the Docker documentation about [how // `CMD` and `ENTRYPOINT` - // [interact](https://tinyurl.com/h3kdcgs). + // interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). // // If you specify this field, then you can also specify the `args` field to // provide additional arguments for this command. However, if you specify this // field, then the container's `CMD` is ignored. See the - // [Kubernetes documentation](https://tinyurl.com/y8bvllf4) about how the + // [Kubernetes documentation about how the // `command` and `args` fields interact with a container's `ENTRYPOINT` and - // `CMD`. + // `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). // - // In this field, you can reference environment variables - // [set by AI Platform](https://tinyurl.com/cust-cont-reqs#aip-variables) + // In this field, you can reference [environment variables set by Vertex + // AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) // and environment variables set in the [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. // You cannot reference environment variables set in the Docker image. In // order for environment variables to be expanded, reference them by using the @@ -367,7 +371,8 @@ message ModelContainerSpec { // syntax with `$$`; for example: // $$(VARIABLE_NAME) // This field corresponds to the `command` field of the Kubernetes Containers - // [v1 core API](https://tinyurl.com/k8s-io-api/v1.18/#container-v1-core). + // [v1 core + // API](https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). repeated string command = 2 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. Specifies arguments for the command that runs when the container starts. @@ -379,19 +384,20 @@ message ModelContainerSpec { // If you don't specify this field but do specify the // [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] field, then the command from the // `command` field runs without any additional arguments. See the - // [Kubernetes documentation](https://tinyurl.com/y8bvllf4) about how the + // [Kubernetes documentation about how the // `command` and `args` fields interact with a container's `ENTRYPOINT` and - // `CMD`. + // `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). // // If you don't specify this field and don't specify the `command` field, // then the container's // [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and // `CMD` determine what runs based on their default behavior. See the Docker - // documentation about how `CMD` and `ENTRYPOINT` - // [interact](https://tinyurl.com/h3kdcgs). + // documentation about [how `CMD` and `ENTRYPOINT` + // interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). // - // In this field, you can reference environment variables - // [set by AI Platform](https://tinyurl.com/cust-cont-reqs#aip-variables) + // In this field, you can reference [environment variables + // set by Vertex + // AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) // and environment variables set in the [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. // You cannot reference environment variables set in the Docker image. In // order for environment variables to be expanded, reference them by using the @@ -403,7 +409,8 @@ message ModelContainerSpec { // syntax with `$$`; for example: // $$(VARIABLE_NAME) // This field corresponds to the `args` field of the Kubernetes Containers - // [v1 core API](https://tinyurl.com/k8s-io-api/v1.18/#container-v1-core). + // [v1 core + // API](https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). repeated string args = 3 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. List of environment variables to set in the container. After the container @@ -432,13 +439,15 @@ message ModelContainerSpec { // does not occur. // // This field corresponds to the `env` field of the Kubernetes Containers - // [v1 core API](https://tinyurl.com/k8s-io-api/v1.18/#container-v1-core). + // [v1 core + // API](https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). repeated EnvVar env = 4 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. List of ports to expose from the container. AI Platform sends any + // Immutable. List of ports to expose from the container. Vertex AI sends any // prediction requests that it receives to the first port on this list. AI // Platform also sends - // [liveness and health checks](https://tinyurl.com/cust-cont-reqs#health) + // [liveness and health + // checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) // to this port. // // If you do not specify this field, it defaults to following value: @@ -451,18 +460,19 @@ message ModelContainerSpec { // ] // ``` // - // AI Platform does not use ports other than the first one listed. This field + // Vertex AI does not use ports other than the first one listed. This field // corresponds to the `ports` field of the Kubernetes Containers - // [v1 core API](https://tinyurl.com/k8s-io-api/v1.18/#container-v1-core). + // [v1 core + // API](https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). repeated Port ports = 5 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. HTTP path on the container to send prediction requests to. AI Platform + // Immutable. HTTP path on the container to send prediction requests to. Vertex AI // forwards requests sent using // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1.PredictionService.Predict] to this - // path on the container's IP address and port. AI Platform then returns the + // path on the container's IP address and port. Vertex AI then returns the // container's response in the API response. // - // For example, if you set this field to `/foo`, then when AI Platform + // For example, if you set this field to `/foo`, then when Vertex AI // receives a prediction request, it forwards the request body in a POST // request to the `/foo` path on the port of your container specified by the // first value of this `ModelContainerSpec`'s @@ -475,24 +485,23 @@ message ModelContainerSpec { // // * ENDPOINT: The last segment (following `endpoints/`)of the // Endpoint.name][] field of the Endpoint where this Model has been - // deployed. (AI Platform makes this value available to your container code - // as the - // [`AIP_ENDPOINT_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables) - // environment variable.) + // deployed. (Vertex AI makes this value available to your container code + // as the [`AIP_ENDPOINT_ID` environment + // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) // // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the `DeployedModel`. - // (AI Platform makes this value available to your container code + // (Vertex AI makes this value available to your container code // as the [`AIP_DEPLOYED_MODEL_ID` environment - // variable](https://tinyurl.com/cust-cont-reqs#aip-variables).) + // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) string predict_route = 6 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. HTTP path on the container to send health checks to. AI Platform + // Immutable. HTTP path on the container to send health checks to. Vertex AI // intermittently sends GET requests to this path on the container's IP // address and port to check that the container is healthy. Read more about // [health - // checks](https://tinyurl.com/cust-cont-reqs#checks). + // checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). // - // For example, if you set this field to `/bar`, then AI Platform + // For example, if you set this field to `/bar`, then Vertex AI // intermittently sends a GET request to the `/bar` path on the port of your // container specified by the first value of this `ModelContainerSpec`'s // [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field. @@ -504,15 +513,14 @@ message ModelContainerSpec { // // * ENDPOINT: The last segment (following `endpoints/`)of the // Endpoint.name][] field of the Endpoint where this Model has been - // deployed. (AI Platform makes this value available to your container code - // as the - // [`AIP_ENDPOINT_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables) - // environment variable.) + // deployed. (Vertex AI makes this value available to your container code + // as the [`AIP_ENDPOINT_ID` environment + // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) // // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the `DeployedModel`. - // (AI Platform makes this value available to your container code as the - // [`AIP_DEPLOYED_MODEL_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables) - // environment variable.) + // (Vertex AI makes this value available to your container code as the + // [`AIP_DEPLOYED_MODEL_ID` environment + // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) string health_route = 7 [(google.api.field_behavior) = IMMUTABLE]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto index 6596a4fc26a..402acd83e2c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -40,8 +40,8 @@ message ModelEvaluation { // Output only. Points to a YAML file stored on Google Cloud Storage describing the // [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is - // defined as an OpenAPI 3.0.2 - // [Schema Object](https://tinyurl.com/y538mdwt#schema-object). + // defined as an OpenAPI 3.0.2 [Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string metrics_schema_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Evaluation metrics of the Model. The schema of the metrics is stored in diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto index 78656ed7a5d..6fc6f9bdbd9 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -56,8 +56,8 @@ message ModelEvaluationSlice { // Output only. Points to a YAML file stored on Google Cloud Storage describing the // [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this ModelEvaluationSlice. The - // schema is defined as an OpenAPI 3.0.2 - // [Schema Object](https://tinyurl.com/y538mdwt#schema-object). + // schema is defined as an OpenAPI 3.0.2 [Schema + // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string metrics_schema_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto index 55c3bf99ce9..93c9b79c0b7 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -33,12 +33,12 @@ option java_multiple_files = true; option java_outer_classname = "ModelServiceProto"; option java_package = "com.google.cloud.aiplatform.v1"; -// A service for managing AI Platform's machine learning Models. +// A service for managing Vertex AI's machine learning Models. service ModelService { option (google.api.default_host) = "aiplatform.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; - // Uploads a Model artifact into AI Platform. + // Uploads a Model artifact into Vertex AI. rpc UploadModel(UploadModelRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/models:upload" @@ -247,8 +247,7 @@ message UpdateModelRequest { Model model = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - // For the `FieldMask` definition, see - // [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask). + // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -335,7 +334,6 @@ message ExportModelResponse { message GetModelEvaluationRequest { // Required. The name of the ModelEvaluation resource. // Format: - // // `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -386,7 +384,6 @@ message ListModelEvaluationsResponse { message GetModelEvaluationSliceRequest { // Required. The name of the ModelEvaluationSlice resource. // Format: - // // `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -400,7 +397,6 @@ message GetModelEvaluationSliceRequest { message ListModelEvaluationSlicesRequest { // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices // from. Format: - // // `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto index e3b1d3c7370..0b775ad4836 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto index 60d06d60ce3..33807e82dac 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -30,7 +30,9 @@ option java_multiple_files = true; option java_outer_classname = "PipelineServiceProto"; option java_package = "com.google.cloud.aiplatform.v1"; -// A service for creating and managing AI Platform's pipelines. +// A service for creating and managing Vertex AI's pipelines. This includes both +// `TrainingPipeline` resources (used for AutoML and custom training) and +// `PipelineJob` resources (used for Vertex Pipelines). service PipelineService { option (google.api.default_host) = "aiplatform.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; @@ -111,7 +113,6 @@ message CreateTrainingPipelineRequest { message GetTrainingPipelineRequest { // Required. The name of the TrainingPipeline resource. // Format: - // // `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -177,7 +178,6 @@ message ListTrainingPipelinesResponse { message DeleteTrainingPipelineRequest { // Required. The name of the TrainingPipeline resource to be deleted. // Format: - // // `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -191,7 +191,6 @@ message DeleteTrainingPipelineRequest { message CancelTrainingPipelineRequest { // Required. The name of the TrainingPipeline to cancel. // Format: - // // `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` string name = 1 [ (google.api.field_behavior) = REQUIRED, diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_state.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_state.proto index 42abd26f100..1f0565acb77 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_state.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_state.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -28,7 +28,7 @@ enum PipelineState { // The pipeline state is unspecified. PIPELINE_STATE_UNSPECIFIED = 0; - // The pipeline has been just created or resumed and processing has not yet + // The pipeline has been created or resumed, and processing has not yet // begun. PIPELINE_STATE_QUEUED = 1; @@ -44,7 +44,7 @@ enum PipelineState { // The pipeline failed. PIPELINE_STATE_FAILED = 5; - // The pipeline is being cancelled. From this state the pipeline may only go + // The pipeline is being cancelled. From this state, the pipeline may only go // to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or // PIPELINE_STATE_CANCELLED. PIPELINE_STATE_CANCELLING = 6; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto index 146c1a47a19..e8cdad76317 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto index 2f2900433f7..9363637754a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto index 3ac9f3889f4..68fe293971f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -121,7 +121,6 @@ message CreateSpecialistPoolOperationMetadata { message GetSpecialistPoolRequest { // Required. The name of the SpecialistPool resource. // The form is - // // `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, @@ -195,7 +194,6 @@ message UpdateSpecialistPoolRequest { message UpdateSpecialistPoolOperationMetadata { // Output only. The name of the SpecialistPool to which the specialists are being added. // Format: - // // `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` string specialist_pool = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto index 7e54aa9b421..1873ba14ae1 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -260,7 +260,9 @@ message StudySpec { // The available search algorithms for the Study. enum Algorithm { - // The default algorithm used by AI Platform Optimization service. + // The default algorithm used by Vertex AI for [hyperparameter + // tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) + // and [Vertex Vizier](https://cloud.google.com/vertex-ai/docs/vizier). ALGORITHM_UNSPECIFIED = 0; // Simple grid search within the feasible space. To use grid search, @@ -276,15 +278,15 @@ message StudySpec { // "Noisy" means that the repeated observations with the same Trial parameters // may lead to different metric evaluations. enum ObservationNoise { - // The default noise level chosen by the AI Platform service. + // The default noise level chosen by Vertex AI. OBSERVATION_NOISE_UNSPECIFIED = 0; - // AI Platform Vizier assumes that the objective function is (nearly) + // Vertex AI assumes that the objective function is (nearly) // perfectly reproducible, and will never repeat the same Trial // parameters. LOW = 1; - // AI Platform Vizier will estimate the amount of noise in metric + // Vertex AI will estimate the amount of noise in metric // evaluations, it may repeat the same Trial parameters more than once. HIGH = 2; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto index 1ede99df08e..8ac39343cc7 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto @@ -1,4 +1,4 @@ -// Copyright 2020 Google LLC +// Copyright 2021 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -36,8 +36,8 @@ option java_package = "com.google.cloud.aiplatform.v1"; // The TrainingPipeline orchestrates tasks associated with training a Model. It // always executes the training task, and optionally may also -// export data from AI Platform's Dataset which becomes the training input, -// [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to AI Platform, and evaluate the +// export data from Vertex AI's Dataset which becomes the training input, +// [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the // Model. message TrainingPipeline { option (google.api.resource) = { @@ -51,7 +51,7 @@ message TrainingPipeline { // Required. The user-defined name of this TrainingPipeline. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // Specifies AI Platform owned input data that may be used for training the + // Specifies Vertex AI owned input data that may be used for training the // Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] should make // clear whether this config is used and if there are any special requirements // on how it should be filled. If nothing about this config is mentioned in @@ -90,7 +90,7 @@ message TrainingPipeline { // a need of this information, or that training task does not support // uploading a Model as part of the pipeline. // When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and - // the trained Model had been uploaded into AI Platform, then the + // the trained Model had been uploaded into Vertex AI, then the // model_to_upload's resource [name][google.cloud.aiplatform.v1.Model.name] is populated. The Model // is always uploaded into the Project and Location in which this pipeline // is. @@ -135,7 +135,7 @@ message TrainingPipeline { EncryptionSpec encryption_spec = 18; } -// Specifies AI Platform owned input data to be used for training, and +// Specifies Vertex AI owned input data to be used for training, and // possibly evaluating, the Model. message InputDataConfig { // The instructions how the input data should be split between the @@ -167,7 +167,7 @@ message InputDataConfig { // * For non-tabular data: "jsonl". // * For tabular data: "csv" and "bigquery". // - // The following AI Platform environment variables are passed to containers + // The following Vertex AI environment variables are passed to containers // or python modules of the training task when this field is set: // // * AIP_DATA_FORMAT : Exported data format. @@ -182,21 +182,18 @@ message InputDataConfig { // where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. // All training input data is written into that directory. // - // The AI Platform environment variables representing Cloud Storage + // The Vertex AI environment variables representing Cloud Storage // data URIs are represented in the Cloud Storage wildcard // format to support sharded data. e.g.: "gs://.../training-*.jsonl" // // * AIP_DATA_FORMAT = "jsonl" for non-tabular data, "csv" for tabular data // * AIP_TRAINING_DATA_URI = - // // "gcs_destination/dataset---