Skip to content

Commit 77c47e9

Browse files
feat(notebooks): update the api
#### notebooks:v1 The following keys were added: - schemas.ExecutionTemplate.properties.tensorboard.type (Total Keys: 1)
1 parent 62cb631 commit 77c47e9

File tree

4 files changed

+18
-5
lines changed

4 files changed

+18
-5
lines changed

docs/dyn/notebooks_v1.projects.locations.executions.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ <h3>Method Details</h3>
132132
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
133133
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
134134
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
135+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
135136
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
136137
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
137138
&quot;a_key&quot;: &quot;A String&quot;,
@@ -250,6 +251,7 @@ <h3>Method Details</h3>
250251
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
251252
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
252253
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
254+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
253255
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
254256
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
255257
&quot;a_key&quot;: &quot;A String&quot;,
@@ -310,6 +312,7 @@ <h3>Method Details</h3>
310312
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
311313
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
312314
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
315+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
313316
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
314317
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
315318
&quot;a_key&quot;: &quot;A String&quot;,

docs/dyn/notebooks_v1.projects.locations.runtimes.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ <h3>Method Details</h3>
150150
&quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. Default: True
151151
&quot;idleShutdown&quot;: True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True
152152
&quot;idleShutdownTimeout&quot;: 42, # Time in minutes to wait before shutting down runtime. Default: 180 minutes
153-
&quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically.
153+
&quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically. Default: True
154154
&quot;kernels&quot;: [ # Optional. Use a list of container images to use as Kernels in the notebook instance.
155155
{ # Definition of a container image for starting a notebook instance with the environment installed in a container.
156156
&quot;repository&quot;: &quot;A String&quot;, # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
@@ -334,7 +334,7 @@ <h3>Method Details</h3>
334334
&quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. Default: True
335335
&quot;idleShutdown&quot;: True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True
336336
&quot;idleShutdownTimeout&quot;: 42, # Time in minutes to wait before shutting down runtime. Default: 180 minutes
337-
&quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically.
337+
&quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically. Default: True
338338
&quot;kernels&quot;: [ # Optional. Use a list of container images to use as Kernels in the notebook instance.
339339
{ # Definition of a container image for starting a notebook instance with the environment installed in a container.
340340
&quot;repository&quot;: &quot;A String&quot;, # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
@@ -494,7 +494,7 @@ <h3>Method Details</h3>
494494
&quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. Default: True
495495
&quot;idleShutdown&quot;: True or False, # Runtime will automatically shutdown after idle_shutdown_time. Default: True
496496
&quot;idleShutdownTimeout&quot;: 42, # Time in minutes to wait before shutting down runtime. Default: 180 minutes
497-
&quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically.
497+
&quot;installGpuDriver&quot;: True or False, # Install Nvidia Driver automatically. Default: True
498498
&quot;kernels&quot;: [ # Optional. Use a list of container images to use as Kernels in the notebook instance.
499499
{ # Definition of a container image for starting a notebook instance with the environment installed in a container.
500500
&quot;repository&quot;: &quot;A String&quot;, # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`

docs/dyn/notebooks_v1.projects.locations.schedules.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ <h3>Method Details</h3>
136136
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
137137
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
138138
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
139+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
139140
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
140141
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
141142
&quot;a_key&quot;: &quot;A String&quot;,
@@ -170,6 +171,7 @@ <h3>Method Details</h3>
170171
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
171172
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
172173
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
174+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
173175
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
174176
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
175177
&quot;a_key&quot;: &quot;A String&quot;,
@@ -294,6 +296,7 @@ <h3>Method Details</h3>
294296
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
295297
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
296298
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
299+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
297300
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
298301
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
299302
&quot;a_key&quot;: &quot;A String&quot;,
@@ -328,6 +331,7 @@ <h3>Method Details</h3>
328331
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
329332
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
330333
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
334+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
331335
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
332336
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
333337
&quot;a_key&quot;: &quot;A String&quot;,
@@ -395,6 +399,7 @@ <h3>Method Details</h3>
395399
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
396400
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
397401
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
402+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
398403
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
399404
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
400405
&quot;a_key&quot;: &quot;A String&quot;,
@@ -429,6 +434,7 @@ <h3>Method Details</h3>
429434
&quot;paramsYamlFile&quot;: &quot;A String&quot;, # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
430435
&quot;scaleTier&quot;: &quot;A String&quot;, # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
431436
&quot;serviceAccount&quot;: &quot;A String&quot;, # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
437+
&quot;tensorboard&quot;: &quot;A String&quot;, # The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
432438
&quot;vertexAiParameters&quot;: { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
433439
&quot;env&quot;: { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
434440
&quot;a_key&quot;: &quot;A String&quot;,

googleapiclient/discovery_cache/documents/notebooks.v1.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1743,7 +1743,7 @@
17431743
}
17441744
}
17451745
},
1746-
"revision": "20220205",
1746+
"revision": "20220214",
17471747
"rootUrl": "https://notebooks.googleapis.com/",
17481748
"schemas": {
17491749
"AcceleratorConfig": {
@@ -2159,6 +2159,10 @@
21592159
"description": "The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.",
21602160
"type": "string"
21612161
},
2162+
"tensorboard": {
2163+
"description": "The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
2164+
"type": "string"
2165+
},
21622166
"vertexAiParameters": {
21632167
"$ref": "VertexAIParameters",
21642168
"description": "Parameters used in Vertex AI JobType executions."
@@ -3259,7 +3263,7 @@
32593263
"type": "integer"
32603264
},
32613265
"installGpuDriver": {
3262-
"description": "Install Nvidia Driver automatically.",
3266+
"description": "Install Nvidia Driver automatically. Default: True",
32633267
"type": "boolean"
32643268
},
32653269
"kernels": {

0 commit comments

Comments
 (0)