Class TensorboardServiceAsyncClient (1.0.1)

TensorboardServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.tensorboard_service.transports.base.TensorboardServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

TensorboardService

Inheritance

builtins.object > TensorboardServiceAsyncClient

Properties

transport

Return the transport used by the client instance.

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

Methods

TensorboardServiceAsyncClient

TensorboardServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.tensorboard_service.transports.base.TensorboardServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate 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 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.

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)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return 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 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 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_async.AsyncOperation 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 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 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 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 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 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