Google Cloud Ai Platform V1 Client - Class WriteTensorboardRunDataRequest (1.2.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class WriteTensorboardRunDataRequest.

Request message for TensorboardService.WriteTensorboardRunData.

Generated from protobuf message google.cloud.aiplatform.v1.WriteTensorboardRunDataRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ tensorboard_run string

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

↳ time_series_data array<Google\Cloud\AIPlatform\V1\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.

getTensorboardRun

Required. The resource name of the TensorboardRun to write data to.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns
Type Description
string

setTensorboardRun

Required. The resource name of the TensorboardRun to write data to.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeSeriesData

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTimeSeriesData

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.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\TimeSeriesData>
Returns
Type Description
$this

static::build

Parameters
Name Description
tensorboardRun string

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} Please see Google\Cloud\AIPlatform\V1\TensorboardServiceClient::tensorboardRunName() for help formatting this field.

timeSeriesData array<Google\Cloud\AIPlatform\V1\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.

Returns
Type Description
Google\Cloud\AIPlatform\V1\WriteTensorboardRunDataRequest