Interactive Apps

TensorBoard on SageMaker

Methods for TensorBoard apps hosted on SageMaker.

This module contains methods for starting up and accessing TensorBoard apps hosted on SageMaker

class sagemaker.interactive_apps.tensorboard.TensorBoardApp(region=None)

Bases: BaseInteractiveApp

TensorBoardApp is a class for creating/accessing a TensorBoard app hosted on Studio.

Initialize a BaseInteractiveApp object.

Parameters

region (str) – Optional. The AWS Region, e.g. us-east-1. If not specified, one is created using the default AWS configuration chain. Default: None

get_app_url(training_job_name=None, open_in_default_web_browser=True, create_presigned_domain_url=False, domain_id=None, user_profile_name=None, optional_create_presigned_url_kwargs=None)

Generate a URL to help access the TensorBoard application hosted in Studio.

For users that are already in SageMaker Studio, this method tries to get the domain id and the user profile from the Studio environment. If successful, the generated URL will direct to the TensorBoard application in SageMaker. Otherwise, it will direct to the TensorBoard landing page in the SageMaker console. If a user outside of SageMaker Studio passes in a valid domain ID and user profile name, the generated URL will be presigned - authenticating the user and redirecting to the TensorBoard app once used. Otherwise, the URL will direct to the TensorBoard landing page in the SageMaker console. By default, the generated URL will attempt to open in the environment’s default web browser.

Parameters

  • training_job_name (str) – Optional. The name of the training job to pre-load in TensorBoard. If nothing provided, the method just returns the TensorBoard application URL. You can add training jobs later by using the SageMaker Data Manager UI. Default: None

  • open_in_default_web_browser (bool) – Optional. When True, the URL will attempt to be opened in the environment’s default web browser. Otherwise, the resulting URL will be returned by this function. Default: True

  • create_presigned_domain_url (bool) – Optional. Determines whether a presigned domain URL should be generated instead of an unsigned URL. This only applies when called from outside of a SageMaker Studio environment. If this is set to True inside of a SageMaker Studio environment, it will be ignored. Default: False

  • domain_id (str) – Optional. This parameter should be passed when a user outside of Studio wants a presigned URL to the TensorBoard application. This value will map to ‘DomainId’ in the resulting create_presigned_domain_url call. Must be passed with user_profile_name and create_presigned_domain_url set to True. Default: None

  • user_profile_name (str) – Optional. This parameter should be passed when a user outside of Studio wants a presigned URL to the TensorBoard application. This value will map to ‘UserProfileName’ in the resulting create_presigned_domain_url call. Must be passed with domain_id and create_presigned_domain_url set to True. Default: None

  • optional_create_presigned_url_kwargs (dict) – Optional. This parameter should be passed when a user outside of Studio wants a presigned URL to the TensorBoard application and wants to modify the optional parameters of the create_presigned_domain_url call. Default: None

Returns

A URL for TensorBoard hosted on SageMaker.

Return type

str

SageMaker Profiler UI application

Methods for starting up and accessing DetailProfiler apps

This module contains methods for starting up and accessing DetailProfiler apps hosted on SageMaker

class sagemaker.interactive_apps.detail_profiler_app.DetailProfilerApp(region=None)

Bases: object

Class for creating/accessing a DetailProfiler app hosted on SageMaker.

Initialize a DetailProfilerApp object.

Parameters

region (str) – The name of the region e.g. us-east-1. If not specified, one is created using the default AWS configuration chain.

get_app_url(training_job_name=None)

Get an unsigned URL for DetailProfiler app hosted on SageMaker.

For users that are already in SM Studio notebook instance, the method tries to get domain id and user profile from the Studio environment. If succeeded, the generated URL will direct to SM DetailProfiler app. Otherwise it will direct to DetailProfiler landing page on SageMaker console. For non Studio users, the URL will direct to the DetailProfiler landing page on SageMaker console.

Parameters

training_job_name (str) – Optional. The name of the training job to pre-load in DetailProfiler. If not provided, no job will be automatically loaded when the URL is opened.

Returns

An unsigned URL for DetailProfiler hosted on SageMaker.

Return type

str