Skip to content

Commit

Permalink
docs: add a sample for create_tensorboard.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 493376367
  • Loading branch information
vertex-sdk-bot authored and Copybara-Service committed Dec 6, 2022
1 parent f8e5842 commit 52656ca
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
13 changes: 13 additions & 0 deletions samples/model-builder/conftest.py
Expand Up @@ -393,6 +393,19 @@ def mock_create_batch_prediction_job():
yield mock


"""
----------------------------------------------------------------------------
Tensorboard Fixtures
----------------------------------------------------------------------------
"""


@pytest.fixture
def mock_create_tensorboard():
with patch.object(aiplatform.tensorboard.Tensorboard, "create") as mock:
yield mock


"""
----------------------------------------------------------------------------
Endpoint Fixtures
Expand Down
37 changes: 37 additions & 0 deletions samples/model-builder/create_tensorboard_sample.py
@@ -0,0 +1,37 @@
# Copyright 2022 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
#
# https://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 google.cloud import aiplatform


# [START aiplatform_sdk_create_tensorboard_sample]
def create_tensorboard_sample(
project: str,
display_name: str,
location: str,
):
aiplatform.init(project=project, location=location)

tensorboard = aiplatform.tensorboard.Tensorboard.create(
display_name=display_name,
project=project,
location=location,
)

print(tensorboard.display_name)
print(tensorboard.resource_name)
return tensorboard


# [END aiplatform_sdk_create_tensorboard_sample]
36 changes: 36 additions & 0 deletions samples/model-builder/create_tensorboard_sample_test.py
@@ -0,0 +1,36 @@
# Copyright 2022 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
#
# https://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.


import create_tensorboard_sample
import test_constants as constants


def test_create_tensorboard_sample(mock_sdk_init, mock_create_tensorboard):

create_tensorboard_sample.create_tensorboard_sample(
project=constants.PROJECT,
display_name=constants.DISPLAY_NAME,
location=constants.LOCATION,
)

mock_sdk_init.assert_called_once_with(
project=constants.PROJECT, location=constants.LOCATION
)

mock_create_tensorboard.assert_called_once_with(
display_name=constants.DISPLAY_NAME,
project=constants.PROJECT,
location=constants.LOCATION,
)

0 comments on commit 52656ca

Please sign in to comment.