docs: Add upload Tensorboard profile log to Experiment sample.

PiperOrigin-RevId: 587819953

Author: vertex-sdk-bot

samples/model-builder/experiment_tracking/upload_tensorboard_profile_logs_to_experiment_sample.py

@@ -0,0 +1,41 @@
+# Copyright 2023 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 typing import FrozenSet
+
+from google.cloud import aiplatform
+
+
+# [START aiplatform_sdk_upload_tensorboard_profile_logs_to_experiment_sample]
+def upload_tensorboard_profile_logs_to_experiment_sample(
+ experiment_name: str,
+ logdir: str,
+ project: str,
+ location: str,
+ run_name_prefix: str,
+ allowed_plugins: FrozenSet[str] = ["profile"],
+) -> None:
+
+ aiplatform.init(project=project, location=location, experiment=experiment_name)
+
+ # one time upload
+ aiplatform.upload_tb_log(
+ tensorboard_experiment_name=experiment_name,
+ logdir=logdir,
+ run_name_prefix=run_name_prefix,
+ allowed_plugins=allowed_plugins,
+ )
+
+
+# [END aiplatform_sdk_upload_tensorboard_profile_logs_to_experiment_sample]

samples/model-builder/experiment_tracking/upload_tensorboard_profile_logs_to_experiment_sample_test.py

@@ -0,0 +1,44 @@
+# Copyright 2023 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 upload_tensorboard_profile_logs_to_experiment_sample
+import test_constants as constants
+
+
+def test_upload_tensorboard_profile_logs_to_experiment_sample(
+ mock_sdk_init,
+ mock_tensorboard_uploader_onetime,
+):
+ upload_tensorboard_profile_logs_to_experiment_sample.upload_tensorboard_profile_logs_to_experiment_sample(
+ project=constants.PROJECT,
+ location=constants.LOCATION,
+ logdir=constants.TENSORBOARD_LOG_DIR,
+ experiment_name=constants.EXPERIMENT_NAME,
+ run_name_prefix=constants.EXPERIMENT_RUN_NAME,
+ allowed_plugins=constants.TENSORBOARD_PLUGIN_PROFILE_NAME,
+ )
+
+ mock_sdk_init.assert_called_once_with(
+ project=constants.PROJECT,
+ location=constants.LOCATION,
+ experiment=constants.EXPERIMENT_NAME,
+ )
+
+ mock_tensorboard_uploader_onetime.assert_called_once_with(
+ logdir=constants.TENSORBOARD_LOG_DIR,
+ tensorboard_experiment_name=constants.EXPERIMENT_NAME,
+ run_name_prefix=constants.EXPERIMENT_RUN_NAME,
+ allowed_plugins=constants.TENSORBOARD_PLUGIN_PROFILE_NAME,
+ )

samples/model-builder/test_constants.py

@@ -337,3 +337,4 @@
  f"projects/{PROJECT}/locations/{LOCATION}/tensorboards/my-tensorboard"
 )
 TENSORBOARD_EXPERIMENT_NAME = "my-tensorboard-experiment"
+TENSORBOARD_PLUGIN_PROFILE_NAME = "profile"