docs: removes tinyurl links

PiperOrigin-RevId: 375484379
pull/744/head
Google APIs 4 years ago committed by Copybara-Service
parent 19bb9a2413
commit f465a6dfa9
  1. 4
      google/cloud/aiplatform/v1beta1/annotation.proto
  2. 3
      google/cloud/aiplatform/v1beta1/dataset.proto
  3. 3
      google/cloud/aiplatform/v1beta1/dataset_service.proto
  4. 4
      google/cloud/aiplatform/v1beta1/endpoint_service.proto
  5. 5
      google/cloud/aiplatform/v1beta1/explanation.proto
  6. 4
      google/cloud/aiplatform/v1beta1/explanation_metadata.proto
  7. 4
      google/cloud/aiplatform/v1beta1/index.proto
  8. 4
      google/cloud/aiplatform/v1beta1/index_endpoint_service.proto
  9. 3
      google/cloud/aiplatform/v1beta1/index_service.proto
  10. 11
      google/cloud/aiplatform/v1beta1/machine_resources.proto
  11. 88
      google/cloud/aiplatform/v1beta1/model.proto
  12. 4
      google/cloud/aiplatform/v1beta1/model_evaluation.proto
  13. 4
      google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto
  14. 3
      google/cloud/aiplatform/v1beta1/model_service.proto
  15. 4
      google/cloud/aiplatform/v1beta1/training_pipeline.proto

@ -41,8 +41,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.v1beta1.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

@ -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];
}

@ -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`

@ -202,9 +202,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];
}

@ -284,9 +284,8 @@ message SmoothGradConfig {
// This is a single float value and will be used to add noise to all the
// features. Use this field when all features are normalized to have the
// same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where
// features are normalized to have 0-mean and 1-variance. For more details
// about normalization:
// https://tinyurl.com/dgc-normalization.
// features are normalized to have 0-mean and 1-variance. Learn more about
// [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization).
//
// For best results the recommended value is about 10% - 20% of the standard
// deviation of the input feature. Refer to section 3.2 of the SmoothGrad

@ -388,8 +388,8 @@ message ExplanationMetadata {
// Points to a YAML file stored on Google Cloud Storage describing the format
// of the [feature attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions].
// The schema is defined as an OpenAPI 3.0.2
// [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
// 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 tabular Models always have this field populated by Vertex AI.
// Note: The URI given on output may be different, including the URI scheme,
// than the one given on input. The output URI will point to a location where

@ -50,8 +50,8 @@ message Index {
// Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
// information about the Index, that is specific to it. Unset if the Index
// does not have any additional information.
// The schema is defined as an OpenAPI 3.0.2
// [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
// 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).
// 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.

@ -209,9 +209,7 @@ message UpdateIndexEndpointRequest {
// Required. The IndexEndpoint which replaces the resource on the server.
IndexEndpoint index_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];
}

@ -172,8 +172,7 @@ message UpdateIndexRequest {
Index index = 1 [(google.api.field_behavior) = 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;
}

@ -27,10 +27,13 @@ option java_package = "com.google.cloud.aiplatform.v1beta1";
// 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.v1beta1.DeployedModel] this field is optional, and the default
// value is `n1-standard-2`. For [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] or as part of

@ -118,8 +118,8 @@ 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).
// 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,
@ -303,8 +303,8 @@ message PredictSchemata {
// of a single instance, which are used in [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
// [ExplainRequest.instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] and
// [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config].
// The schema is defined as an OpenAPI 3.0.2
// [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
// 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
@ -315,8 +315,8 @@ message PredictSchemata {
// parameters of prediction and explanation via
// [PredictRequest.parameters][google.cloud.aiplatform.v1beta1.PredictRequest.parameters], [ExplainRequest.parameters][google.cloud.aiplatform.v1beta1.ExplainRequest.parameters] and
// [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model_parameters].
// The schema is defined as an OpenAPI 3.0.2
// [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
// 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,
@ -328,8 +328,8 @@ message PredictSchemata {
// of a single prediction produced by this Model, which are returned via
// [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions], [ExplainResponse.explanations][google.cloud.aiplatform.v1beta1.ExplainResponse.explanations], and
// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config].
// The schema is defined as an OpenAPI 3.0.2
// [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
// 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
@ -338,21 +338,21 @@ message PredictSchemata {
}
// Specification of a container for serving predictions. Some fields in this
// message correspond to fields in the Kubernetes Container v1 core
// [specification](https://tinyurl.com/k8s-io-api/v1.18/#container-v1-core).
// 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.v1beta1.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)
@ -372,19 +372,19 @@ message ModelContainerSpec {
// in conjunction with the [args][google.cloud.aiplatform.v1beta1.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 Vertex AI](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.v1beta1.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
@ -396,7 +396,8 @@ message ModelContainerSpec {
// syntax with `$$`; for example:
// <code>$$(<var>VARIABLE_NAME</var>)</code>
// 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.
@ -408,19 +409,20 @@ message ModelContainerSpec {
// If you don't specify this field but do specify the
// [command][google.cloud.aiplatform.v1beta1.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 Vertex AI](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.v1beta1.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
@ -432,7 +434,8 @@ message ModelContainerSpec {
// syntax with `$$`; for example:
// <code>$$(<var>VARIABLE_NAME</var>)</code>
// 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
@ -461,13 +464,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. 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:
@ -482,7 +487,8 @@ message ModelContainerSpec {
//
// 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. Vertex AI
@ -505,21 +511,20 @@ message ModelContainerSpec {
// * <var>ENDPOINT</var>: The last segment (following `endpoints/`)of the
// Endpoint.name][] field of the Endpoint where this Model has been
// deployed. (Vertex AI makes this value available to your container code
// as the
// [`AIP_ENDPOINT_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables)
// environment variable.)
// as the [`AIP_ENDPOINT_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
//
// * <var>DEPLOYED_MODEL</var>: [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the `DeployedModel`.
// (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. 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 Vertex AI
// intermittently sends a GET request to the `/bar` path on the port of your
@ -534,14 +539,13 @@ message ModelContainerSpec {
// * <var>ENDPOINT</var>: The last segment (following `endpoints/`)of the
// Endpoint.name][] field of the Endpoint where this Model has been
// deployed. (Vertex AI makes this value available to your container code
// as the
// [`AIP_ENDPOINT_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables)
// environment variable.)
// as the [`AIP_ENDPOINT_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
//
// * <var>DEPLOYED_MODEL</var>: [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the `DeployedModel`.
// (Vertex AI makes this value available to your container code as the
// [`AIP_DEPLOYED_MODEL_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables)
// environment variable.)
// [`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];
}

@ -54,8 +54,8 @@ message ModelEvaluation {
// Output only. Points to a YAML file stored on Google Cloud Storage describing the
// [metrics][google.cloud.aiplatform.v1beta1.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

@ -56,8 +56,8 @@ message ModelEvaluationSlice {
// Output only. Points to a YAML file stored on Google Cloud Storage describing the
// [metrics][google.cloud.aiplatform.v1beta1.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

@ -237,8 +237,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];
}

@ -244,8 +244,8 @@ message InputDataConfig {
// Annotations.
//
// Cloud Storage URI that points to a YAML file describing the annotation
// schema. The schema is defined as an OpenAPI 3.0.2
// [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
// schema. 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).
// 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

Loading…
Cancel
Save