Skip to content

Commit 04c643f

Browse files
feat(aiplatform): update the api
#### aiplatform:v1 The following keys were added: - schemas.GoogleCloudAiplatformV1Checkpoint (Total Keys: 7) - schemas.GoogleCloudAiplatformV1DeployedModel.properties.checkpointId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1Model.properties.checkpoints (Total Keys: 3) - schemas.GoogleCloudAiplatformV1Schema.properties.additionalProperties.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1Schema.properties.defs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1Schema.properties.ref.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SupervisedTuningSpec.properties.exportLastCheckpointOnly.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1TunedModel.properties.checkpoints (Total Keys: 3) - schemas.GoogleCloudAiplatformV1TunedModelCheckpoint (Total Keys: 8) #### aiplatform:v1beta1 The following keys were added: - schemas.GoogleCloudAiplatformV1beta1Checkpoint (Total Keys: 7) - schemas.GoogleCloudAiplatformV1beta1DeployedModel.properties.checkpointId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Example.properties.name.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Model.properties.checkpoints (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1Schema.properties.additionalProperties.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Schema.properties.defs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Schema.properties.ref.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SupervisedTuningSpec.properties.exportLastCheckpointOnly.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1TunedModel.properties.checkpoints (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1TunedModelCheckpoint (Total Keys: 8)
1 parent dd6a5a3 commit 04c643f

27 files changed

+1080
-46
lines changed

docs/dyn/aiplatform_v1.endpoints.html

Lines changed: 45 additions & 0 deletions
Large diffs are not rendered by default.

docs/dyn/aiplatform_v1.projects.locations.cachedContents.html

Lines changed: 60 additions & 0 deletions
Large diffs are not rendered by default.

docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,7 @@ <h3>Method Details</h3>
455455
&quot;maxReplicaCount&quot;: 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic 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 Vertex AI may be unable to scale beyond certain replica number.
456456
&quot;minReplicaCount&quot;: 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.
457457
},
458+
&quot;checkpointId&quot;: &quot;A String&quot;, # The checkpoint id of the model.
458459
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the DeployedModel was created.
459460
&quot;dedicatedResources&quot;: { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
460461
&quot;autoscalingMetricSpecs&quot;: [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator&#x27;s duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator&#x27;s duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`.

docs/dyn/aiplatform_v1.projects.locations.endpoints.html

Lines changed: 53 additions & 0 deletions
Large diffs are not rendered by default.

docs/dyn/aiplatform_v1.projects.locations.models.html

Lines changed: 49 additions & 0 deletions
Large diffs are not rendered by default.

docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ <h3>Method Details</h3>
182182
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
183183
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
184184
},
185-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Optional. The notebook software configuration of the notebook runtime.
185+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Optional. The notebook software configuration of the notebook runtime.
186186
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
187187
{ # Represents an environment variable present in a Container or Python Module.
188188
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
@@ -335,7 +335,7 @@ <h3>Method Details</h3>
335335
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
336336
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
337337
},
338-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Optional. The notebook software configuration of the notebook runtime.
338+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Optional. The notebook software configuration of the notebook runtime.
339339
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
340340
{ # Represents an environment variable present in a Container or Python Module.
341341
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
@@ -467,7 +467,7 @@ <h3>Method Details</h3>
467467
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
468468
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
469469
},
470-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Optional. The notebook software configuration of the notebook runtime.
470+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Optional. The notebook software configuration of the notebook runtime.
471471
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
472472
{ # Represents an environment variable present in a Container or Python Module.
473473
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
@@ -567,7 +567,7 @@ <h3>Method Details</h3>
567567
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
568568
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
569569
},
570-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Optional. The notebook software configuration of the notebook runtime.
570+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Optional. The notebook software configuration of the notebook runtime.
571571
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
572572
{ # Represents an environment variable present in a Container or Python Module.
573573
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
@@ -650,7 +650,7 @@ <h3>Method Details</h3>
650650
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
651651
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
652652
},
653-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Optional. The notebook software configuration of the notebook runtime.
653+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Optional. The notebook software configuration of the notebook runtime.
654654
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
655655
{ # Represents an environment variable present in a Container or Python Module.
656656
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.

docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3>Method Details</h3>
117117
The object takes the form of:
118118

119119
{ # Request message for NotebookService.AssignNotebookRuntime.
120-
&quot;notebookRuntime&quot;: { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours. # Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.
120+
&quot;notebookRuntime&quot;: { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. # Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.
121121
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this NotebookRuntime was created.
122122
&quot;dataPersistentDiskSpec&quot;: { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
123123
&quot;diskSizeGb&quot;: &quot;A String&quot;, # Size in GB of the disk (default is 100GB).
@@ -184,7 +184,7 @@ <h3>Method Details</h3>
184184
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
185185
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
186186
},
187-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Output only. Software config of the notebook runtime.
187+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Output only. Software config of the notebook runtime.
188188
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
189189
{ # Represents an environment variable present in a Container or Python Module.
190190
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
@@ -287,7 +287,7 @@ <h3>Method Details</h3>
287287
Returns:
288288
An object of the form:
289289

290-
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
290+
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.
291291
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this NotebookRuntime was created.
292292
&quot;dataPersistentDiskSpec&quot;: { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
293293
&quot;diskSizeGb&quot;: &quot;A String&quot;, # Size in GB of the disk (default is 100GB).
@@ -354,7 +354,7 @@ <h3>Method Details</h3>
354354
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
355355
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
356356
},
357-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Output only. Software config of the notebook runtime.
357+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Output only. Software config of the notebook runtime.
358358
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
359359
{ # Represents an environment variable present in a Container or Python Module.
360360
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
@@ -394,7 +394,7 @@ <h3>Method Details</h3>
394394
{ # Response message for NotebookService.ListNotebookRuntimes.
395395
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve next page of results. Pass to ListNotebookRuntimesRequest.page_token to obtain that page.
396396
&quot;notebookRuntimes&quot;: [ # List of NotebookRuntimes in the requested page.
397-
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
397+
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.
398398
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this NotebookRuntime was created.
399399
&quot;dataPersistentDiskSpec&quot;: { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
400400
&quot;diskSizeGb&quot;: &quot;A String&quot;, # Size in GB of the disk (default is 100GB).
@@ -461,7 +461,7 @@ <h3>Method Details</h3>
461461
&quot;shieldedVmConfig&quot;: { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
462462
&quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
463463
},
464-
&quot;softwareConfig&quot;: { # Notebook Software Config. # Output only. Software config of the notebook runtime.
464+
&quot;softwareConfig&quot;: { # Notebook Software Config. This is passed to the backend when user makes software configurations in UI. # Output only. Software config of the notebook runtime.
465465
&quot;env&quot;: [ # Optional. Environment variables to be passed to the container. Maximum limit is 100.
466466
{ # Represents an environment variable present in a Container or Python Module.
467467
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.

0 commit comments

Comments
 (0)