Class TensorboardServiceClient (1.2.0) 

TensorboardServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1beta1.services.tensorboard_service.transports.base.TensorboardServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

TensorboardService

Inheritance

builtins.object > TensorboardServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns
Type Description
TensorboardServiceTransport The transport used by the client instance.

Methods

TensorboardServiceClient

TensorboardServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1beta1.services.tensorboard_service.transports.base.TensorboardServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the tensorboard service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Union[str, TensorboardServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.
client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_tensorboard

create_tensorboard(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRequest] = None, *, parent: Optional[str] = None, tensorboard: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a Tensorboard.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.CreateTensorboardRequest

The request object. Request message for TensorboardService.CreateTensorboard.
parent str

Required. The resource name of the Location to create the Tensorboard in. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
tensorboard google.cloud.aiplatform_v1beta1.types.Tensorboard

Required. The Tensorboard to create. This corresponds to the tensorboard field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Tensorboard Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a GCP project. If needed users can also create extra Tensorboards in their projects.

create_tensorboard_experiment

create_tensorboard_experiment(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardExperimentRequest] = None, *, parent: Optional[str] = None, tensorboard_experiment: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment] = None, tensorboard_experiment_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a TensorboardExperiment.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.CreateTensorboardExperimentRequest

The request object. Request message for TensorboardService.CreateTensorboardExperiment.
parent str

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
tensorboard_experiment google.cloud.aiplatform_v1beta1.types.TensorboardExperiment

The TensorboardExperiment to create. This corresponds to the tensorboard_experiment field on the request instance; if request is provided, this should not be set.
tensorboard_experiment_id str

Required. The ID to use for the Tensorboard experiment, which will become the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z][0-9]-/. This corresponds to the tensorboard_experiment_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardExperiment A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

create_tensorboard_run

create_tensorboard_run(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardRunRequest] = None, *, parent: Optional[str] = None, tensorboard_run: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun] = None, tensorboard_run_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a TensorboardRun.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.CreateTensorboardRunRequest

The request object. Request message for TensorboardService.CreateTensorboardRun.
parent str

Required. The resource name of the Tensorboard to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
tensorboard_run google.cloud.aiplatform_v1beta1.types.TensorboardRun

Required. The TensorboardRun to create. This corresponds to the tensorboard_run field on the request instance; if request is provided, this should not be set.
tensorboard_run_id str

Required. The ID to use for the Tensorboard run, which will become the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z][0-9]-/. This corresponds to the tensorboard_run_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardRun TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc

create_tensorboard_time_series

create_tensorboard_time_series(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.CreateTensorboardTimeSeriesRequest] = None, *, parent: Optional[str] = None, tensorboard_time_series: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a TensorboardTimeSeries.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.CreateTensorboardTimeSeriesRequest

The request object. Request message for TensorboardService.CreateTensorboardTimeSeries.
parent str

Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
tensorboard_time_series google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries

Required. The TensorboardTimeSeries to create. This corresponds to the tensorboard_time_series field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries TensorboardTimeSeries maps to times series produced in training runs

delete_tensorboard

delete_tensorboard(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a Tensorboard.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.DeleteTensorboardRequest

The request object. Request message for TensorboardService.DeleteTensorboard.
name str

Required. The name of the Tensorboard to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

delete_tensorboard_experiment

delete_tensorboard_experiment(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardExperimentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a TensorboardExperiment.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.DeleteTensorboardExperimentRequest

The request object. Request message for TensorboardService.DeleteTensorboardExperiment.
name str

Required. The name of the TensorboardExperiment to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

delete_tensorboard_run

delete_tensorboard_run(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardRunRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a TensorboardRun.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.DeleteTensorboardRunRequest

The request object. Request message for TensorboardService.DeleteTensorboardRun.
name str

Required. The name of the TensorboardRun to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

delete_tensorboard_time_series

delete_tensorboard_time_series(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.DeleteTensorboardTimeSeriesRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a TensorboardTimeSeries.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.DeleteTensorboardTimeSeriesRequest

The request object. Request message for TensorboardService.DeleteTensorboardTimeSeries.
name str

Required. The name of the TensorboardTimeSeries to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

export_tensorboard_time_series_data

export_tensorboard_time_series_data(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.ExportTensorboardTimeSeriesDataRequest] = None, *, tensorboard_time_series: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.ExportTensorboardTimeSeriesDataRequest

The request object. Request message for TensorboardService.ExportTensorboardTimeSeriesData.
tensorboard_time_series str

Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} This corresponds to the tensorboard_time_series field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ExportTensorboardTimeSeriesDataPager Response message for TensorboardService.ExportTensorboardTimeSeriesData. Iterating over this object will yield results and resolve additional pages automatically.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
TensorboardServiceClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
TensorboardServiceClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
TensorboardServiceClient The constructed client.

get_tensorboard

get_tensorboard(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a Tensorboard.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.GetTensorboardRequest

The request object. Request message for TensorboardService.GetTensorboard.
name str

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.Tensorboard Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a GCP project. If needed users can also create extra Tensorboards in their projects.

get_tensorboard_experiment

get_tensorboard_experiment(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardExperimentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a TensorboardExperiment.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.GetTensorboardExperimentRequest

The request object. Request message for TensorboardService.GetTensorboardExperiment.
name str

Required. The name of the TensorboardExperiment resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardExperiment A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

get_tensorboard_run

get_tensorboard_run(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardRunRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a TensorboardRun.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.GetTensorboardRunRequest

The request object. Request message for TensorboardService.GetTensorboardRun.
name str

Required. The name of the TensorboardRun resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardRun TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc

get_tensorboard_time_series

get_tensorboard_time_series(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.GetTensorboardTimeSeriesRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a TensorboardTimeSeries.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.GetTensorboardTimeSeriesRequest

The request object. Request message for TensorboardService.GetTensorboardTimeSeries.
name str

Required. The name of the TensorboardTimeSeries resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries TensorboardTimeSeries maps to times series produced in training runs

list_tensorboard_experiments

list_tensorboard_experiments(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardExperimentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists TensorboardExperiments in a Location.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.ListTensorboardExperimentsRequest

The request object. Request message for TensorboardService.ListTensorboardExperiments.
parent str

Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardExperimentsPager Response message for TensorboardService.ListTensorboardExperiments. Iterating over this object will yield results and resolve additional pages automatically.

list_tensorboard_runs

list_tensorboard_runs(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardRunsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists TensorboardRuns in a Location.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.ListTensorboardRunsRequest

The request object. Request message for TensorboardService.ListTensorboardRuns.
parent str

Required. The resource name of the Tensorboard to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardRunsPager Response message for TensorboardService.ListTensorboardRuns. Iterating over this object will yield results and resolve additional pages automatically.

list_tensorboard_time_series

list_tensorboard_time_series(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardTimeSeriesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists TensorboardTimeSeries in a Location.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.ListTensorboardTimeSeriesRequest

The request object. Request message for TensorboardService.ListTensorboardTimeSeries.
parent str

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardTimeSeriesPager Response message for TensorboardService.ListTensorboardTimeSeries. Iterating over this object will yield results and resolve additional pages automatically.

list_tensorboards

list_tensorboards(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.ListTensorboardsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Tensorboards in a Location.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.ListTensorboardsRequest

The request object. Request message for TensorboardService.ListTensorboards.
parent str

Required. The resource name of the Location to list Tensorboards. Format: 'projects/{project}/locations/{location}' This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.services.tensorboard_service.pagers.ListTensorboardsPager Response message for TensorboardService.ListTensorboards. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_tensorboard_experiment_path

parse_tensorboard_experiment_path(path: str)

Parses a tensorboard_experiment path into its component segments.

parse_tensorboard_path

parse_tensorboard_path(path: str)

Parses a tensorboard path into its component segments.

parse_tensorboard_run_path

parse_tensorboard_run_path(path: str)

Parses a tensorboard_run path into its component segments.

parse_tensorboard_time_series_path

parse_tensorboard_time_series_path(path: str)

Parses a tensorboard_time_series path into its component segments.

read_tensorboard_blob_data

read_tensorboard_blob_data(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardBlobDataRequest] = None, *, time_series: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.ReadTensorboardBlobDataRequest

The request object. Request message for TensorboardService.ReadTensorboardBlobData.
time_series str

Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' This corresponds to the time_series field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
Iterable[google.cloud.aiplatform_v1beta1.types.ReadTensorboardBlobDataResponse] Response message for TensorboardService.ReadTensorboardBlobData.

read_tensorboard_time_series_data

read_tensorboard_time_series_data(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.ReadTensorboardTimeSeriesDataRequest] = None, *, tensorboard_time_series: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Reads a TensorboardTimeSeries' data. Data is returned in paginated responses. By default, if the number of data points stored is less than 1000, all data will be returned. Otherwise, 1000 data points will be randomly selected from this time series and returned. This value can be changed by changing max_data_points.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.ReadTensorboardTimeSeriesDataRequest

The request object. Request message for TensorboardService.ReadTensorboardTimeSeriesData.
tensorboard_time_series str

Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} This corresponds to the tensorboard_time_series field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.ReadTensorboardTimeSeriesDataResponse Response message for TensorboardService.ReadTensorboardTimeSeriesData.

tensorboard_experiment_path

tensorboard_experiment_path(
    project: str, location: str, tensorboard: str, experiment: str
)

Returns a fully-qualified tensorboard_experiment string.

tensorboard_path

tensorboard_path(project: str, location: str, tensorboard: str)

Returns a fully-qualified tensorboard string.

tensorboard_run_path

tensorboard_run_path(
    project: str, location: str, tensorboard: str, experiment: str, run: str
)

Returns a fully-qualified tensorboard_run string.

tensorboard_time_series_path

tensorboard_time_series_path(
    project: str,
    location: str,
    tensorboard: str,
    experiment: str,
    run: str,
    time_series: str,
)

Returns a fully-qualified tensorboard_time_series string.

update_tensorboard

update_tensorboard(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardRequest] = None, *, tensorboard: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard.Tensorboard] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a Tensorboard.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.UpdateTensorboardRequest

The request object. Request message for TensorboardService.UpdateTensorboard.
tensorboard google.cloud.aiplatform_v1beta1.types.Tensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard} This corresponds to the tensorboard field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Tensorboard Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a GCP project. If needed users can also create extra Tensorboards in their projects.

update_tensorboard_experiment

update_tensorboard_experiment(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardExperimentRequest] = None, *, tensorboard_experiment: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_experiment.TensorboardExperiment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a TensorboardExperiment.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.UpdateTensorboardExperimentRequest

The request object. Request message for TensorboardService.UpdateTensorboardExperiment.
tensorboard_experiment google.cloud.aiplatform_v1beta1.types.TensorboardExperiment

Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} This corresponds to the tensorboard_experiment field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardExperiment A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

update_tensorboard_run

update_tensorboard_run(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardRunRequest] = None, *, tensorboard_run: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_run.TensorboardRun] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a TensorboardRun.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.UpdateTensorboardRunRequest

The request object. Request message for TensorboardService.UpdateTensorboardRun.
tensorboard_run google.cloud.aiplatform_v1beta1.types.TensorboardRun

Required. The TensorboardRun's name field is used to identify the TensorboardRun to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} This corresponds to the tensorboard_run field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardRun TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc

update_tensorboard_time_series

update_tensorboard_time_series(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.UpdateTensorboardTimeSeriesRequest] = None, *, tensorboard_time_series: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_time_series.TensorboardTimeSeries] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a TensorboardTimeSeries.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.UpdateTensorboardTimeSeriesRequest

The request object. Request message for TensorboardService.UpdateTensorboardTimeSeries.
tensorboard_time_series google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries

Required. The TensorboardTimeSeries' name field is used to identify the TensorboardTimeSeries to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} This corresponds to the tensorboard_time_series field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.TensorboardTimeSeries TensorboardTimeSeries maps to times series produced in training runs

write_tensorboard_run_data

write_tensorboard_run_data(request: Optional[google.cloud.aiplatform_v1beta1.types.tensorboard_service.WriteTensorboardRunDataRequest] = None, *, tensorboard_run: Optional[str] = None, time_series_data: Optional[Sequence[google.cloud.aiplatform_v1beta1.types.tensorboard_data.TimeSeriesData]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error will be returned.

Parameters
Name Description
request google.cloud.aiplatform_v1beta1.types.WriteTensorboardRunDataRequest

The request object. Request message for TensorboardService.WriteTensorboardRunData.
tensorboard_run str

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} This corresponds to the tensorboard_run field on the request instance; if request is provided, this should not be set.
time_series_data Sequence[google.cloud.aiplatform_v1beta1.types.TimeSeriesData]

Required. The TensorboardTimeSeries data to write. Values with in a time series are indexed by their step value. Repeated writes to the same step will overwrite the existing value for that step. The upper limit of data points per write request is 5000. This corresponds to the time_series_data field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1beta1.types.WriteTensorboardRunDataResponse Response message for TensorboardService.WriteTensorboardRunData.