From 138dc1a8085e3260f1b12f68e973f08d72069a9b Mon Sep 17 00:00:00 2001
From: A Vertex SDK engineer <vertex-sdk-bot@google.com>
Date: Fri, 4 Oct 2024 12:09:09 -0700
Subject: [PATCH] docs: Add sample to retrieve experiment backing tensorboard
 resource name

PiperOrigin-RevId: 682406056
---
 ...t_experiment_backing_tensorboard_sample.py | 33 +++++++++++++++++
 ...eriment_backing_tensorboard_sample_test.py | 35 +++++++++++++++++++
 2 files changed, 68 insertions(+)
 create mode 100644 samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample.py
 create mode 100644 samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample_test.py

diff --git a/samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample.py b/samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample.py
new file mode 100644
index 0000000000..f1ef99bafe
--- /dev/null
+++ b/samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample.py
@@ -0,0 +1,33 @@
+# 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.
+
+#  [START aiplatform_sdk_create_experiment_default_tensorboard_sample]
+from google.cloud import aiplatform
+
+
+def get_experiment_backing_tensorboard_resource_name_sample(
+    experiment_name: str,
+    project: str,
+    location: str,
+):
+    backing_tensorboard = aiplatform.Experiment(
+        project=project,
+        location=location,
+        experiment_name=experiment_name
+    ).get_backing_tensorboard_resource()
+
+    return backing_tensorboard.name
+
+
+#  [END aiplatform_sdk_create_experiment_default_tensorboard_sample]
diff --git a/samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample_test.py b/samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample_test.py
new file mode 100644
index 0000000000..205bf3b739
--- /dev/null
+++ b/samples/model-builder/experiment_tracking/get_experiment_backing_tensorboard_sample_test.py
@@ -0,0 +1,35 @@
+# 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 experiment_tracking import get_experiment_backing_tensorboard_sample
+import test_constants as constants
+
+
+def test_get_experiment_backing_tensorboard_resource_name_sample(
+    mock_get_experiment, mock_get_backing_tensorboard_resource
+):
+
+    get_experiment_backing_tensorboard_sample.get_experiment_backing_tensorboard_resource_name_sample(
+        experiment_name=constants.EXPERIMENT_NAME,
+        project=constants.PROJECT,
+        location=constants.LOCATION,
+    )
+
+    mock_get_experiment.assert_called_with(
+        project=constants.PROJECT,
+        location=constants.LOCATION,
+        experiment_name=constants.EXPERIMENT_NAME
+    )
+
+    mock_get_backing_tensorboard_resource.assert_called_once()