/
tensorboard.py
283 lines (236 loc) · 11.1 KB
/
tensorboard.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
# -*- coding: utf-8 -*-
# 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.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from typing import Optional, Sequence, Dict, Tuple
from google.auth import credentials as auth_credentials
from google.protobuf import field_mask_pb2
from google.cloud.aiplatform import base
from google.cloud.aiplatform.compat.types import tensorboard as gca_tensorboard
from google.cloud.aiplatform import initializer
from google.cloud.aiplatform import utils
_LOGGER = base.Logger(__name__)
class Tensorboard(base.VertexAiResourceNounWithFutureManager):
"""Managed tensorboard resource for Vertex AI."""
client_class = utils.TensorboardClientWithOverride
_is_client_prediction_client = False
_resource_noun = "tensorboards"
_getter_method = "get_tensorboard"
_list_method = "list_tensorboards"
_delete_method = "delete_tensorboard"
def __init__(
self,
tensorboard_name: str,
project: Optional[str] = None,
location: Optional[str] = None,
credentials: Optional[auth_credentials.Credentials] = None,
):
"""Retrieves an existing managed tensorboard given a tensorboard name or ID.
Args:
tensorboard_name (str):
Required. A fully-qualified tensorboard resource name or tensorboard ID.
Example: "projects/123/locations/us-central1/tensorboards/456" or
"456" when project and location are initialized or passed.
project (str):
Optional. Project to retrieve tensorboard from. If not set, project
set in aiplatform.init will be used.
location (str):
Optional. Location to retrieve tensorboard from. If not set, location
set in aiplatform.init will be used.
credentials (auth_credentials.Credentials):
Optional. Custom credentials to use to retrieve this Tensorboard. Overrides
credentials set in aiplatform.init.
"""
super().__init__(
project=project,
location=location,
credentials=credentials,
resource_name=tensorboard_name,
)
self._gca_resource = self._get_gca_resource(resource_name=tensorboard_name)
@classmethod
def create(
cls,
display_name: str,
description: Optional[str] = None,
labels: Optional[Dict[str, str]] = None,
project: Optional[str] = None,
location: Optional[str] = None,
credentials: Optional[auth_credentials.Credentials] = None,
request_metadata: Optional[Sequence[Tuple[str, str]]] = (),
encryption_spec_key_name: Optional[str] = None,
) -> "Tensorboard":
"""Creates a new tensorboard.
Example Usage:
tb = aiplatform.Tensorboard.create(
display_name='my display name',
description='my description',
labels={
'key1': 'value1',
'key2': 'value2'
}
)
Args:
display_name (str):
Required. The user-defined name of the Tensorboard.
The name can be up to 128 characters long and can be consist
of any UTF-8 characters.
description (str):
Optional. Description of this Tensorboard.
labels (Dict[str, str]):
Optional. Labels with user-defined metadata to organize your Tensorboards.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one Tensorboard
(System labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
project (str):
Optional. Project to upload this model to. Overrides project set in
aiplatform.init.
location (str):
Optional. Location to upload this model to. Overrides location set in
aiplatform.init.
credentials (auth_credentials.Credentials):
Optional. Custom credentials to use to upload this model. Overrides
credentials set in aiplatform.init.
request_metadata (Sequence[Tuple[str, str]]):
Optional. Strings which should be sent along with the request as metadata.
encryption_spec_key_name (str):
Optional. Cloud KMS resource identifier of the customer
managed encryption key used to protect the tensorboard. Has the
form:
``projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key``.
The key needs to be in the same region as where the compute
resource is created.
If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
Overrides encryption_spec_key_name set in aiplatform.init.
Returns:
tensorboard (Tensorboard):
Instantiated representation of the managed tensorboard resource.
"""
utils.validate_display_name(display_name)
if labels:
utils.validate_labels(labels)
api_client = cls._instantiate_client(location=location, credentials=credentials)
parent = initializer.global_config.common_location_path(
project=project, location=location
)
encryption_spec = initializer.global_config.get_encryption_spec(
encryption_spec_key_name=encryption_spec_key_name
)
gapic_tensorboard = gca_tensorboard.Tensorboard(
display_name=display_name,
description=description,
labels=labels,
encryption_spec=encryption_spec,
)
create_tensorboard_lro = api_client.create_tensorboard(
parent=parent, tensorboard=gapic_tensorboard, metadata=request_metadata
)
_LOGGER.log_create_with_lro(cls, create_tensorboard_lro)
created_tensorboard = create_tensorboard_lro.result()
_LOGGER.log_create_complete(cls, created_tensorboard, "tb")
return cls(
tensorboard_name=created_tensorboard.name,
project=project or initializer.global_config.project,
location=location or initializer.global_config.location,
credentials=credentials,
)
def update(
self,
display_name: Optional[str] = None,
description: Optional[str] = None,
labels: Optional[Dict[str, str]] = None,
request_metadata: Optional[Sequence[Tuple[str, str]]] = (),
encryption_spec_key_name: Optional[str] = None,
) -> "Tensorboard":
"""Updates an existing tensorboard.
Example Usage:
tb = aiplatform.Tensorboard(tensorboard_name='123456')
tb.update(
display_name='update my display name',
description='update my description',
)
Args:
display_name (str):
Optional. User-defined name of the Tensorboard.
The name can be up to 128 characters long and can be consist
of any UTF-8 characters.
description (str):
Optional. Description of this Tensorboard.
labels (Dict[str, str]):
Optional. Labels with user-defined metadata to organize your Tensorboards.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one Tensorboard
(System labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
request_metadata (Sequence[Tuple[str, str]]):
Optional. Strings which should be sent along with the request as metadata.
encryption_spec_key_name (str):
Optional. Cloud KMS resource identifier of the customer
managed encryption key used to protect the tensorboard. Has the
form:
``projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key``.
The key needs to be in the same region as where the compute
resource is created.
If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
Overrides encryption_spec_key_name set in aiplatform.init.
Returns:
tensorboard (Tensorboard):
The managed tensorboard resource.
"""
update_mask = list()
if display_name:
utils.validate_display_name(display_name)
update_mask.append("display_name")
if description:
update_mask.append("description")
if labels:
utils.validate_labels(labels)
update_mask.append("labels")
encryption_spec = None
if encryption_spec_key_name:
encryption_spec = initializer.global_config.get_encryption_spec(
encryption_spec_key_name=encryption_spec_key_name,
)
update_mask.append("encryption_spec")
update_mask = field_mask_pb2.FieldMask(paths=update_mask)
gapic_tensorboard = gca_tensorboard.Tensorboard(
name=self.resource_name,
display_name=display_name,
description=description,
labels=labels,
encryption_spec=encryption_spec,
)
_LOGGER.log_action_start_against_resource(
"Updating", "tensorboard", self,
)
update_tensorboard_lro = self.api_client.update_tensorboard(
tensorboard=gapic_tensorboard,
update_mask=update_mask,
metadata=request_metadata,
)
_LOGGER.log_action_started_against_resource_with_lro(
"Update", "tensorboard", self.__class__, update_tensorboard_lro
)
update_tensorboard_lro.result()
_LOGGER.log_action_completed_against_resource("tensorboard", "updated", self)
return self