Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

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.

Method Details

close()

Close httplib2 connections.

create(parent, body=None, tensorboardTimeSeriesId=None, x__xgafv=None)

Creates a TensorboardTimeSeries.

Args:
  parent: string, Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` (required)
  body: object, The request body.
    The object takes the form of:

{ # TensorboardTimeSeries maps to times series produced in training runs
  "createTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was created.
  "description": "A String", # Description of this TensorboardTimeSeries.
  "displayName": "A String", # Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
  "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  "metadata": { # Describes metadata for a TensorboardTimeSeries. # Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
    "maxBlobSequenceLength": "A String", # Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
    "maxStep": "A String", # Output only. Max step index of all data points within a TensorboardTimeSeries.
    "maxWallTime": "A String", # Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.
  },
  "name": "A String", # Output only. Name of the TensorboardTimeSeries.
  "pluginData": "A String", # Data of the current plugin, with the size limited to 65KB.
  "pluginName": "A String", # Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
  "updateTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was last updated.
  "valueType": "A String", # Required. Immutable. Type of TensorboardTimeSeries value.
}

  tensorboardTimeSeriesId: string, Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # TensorboardTimeSeries maps to times series produced in training runs
  "createTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was created.
  "description": "A String", # Description of this TensorboardTimeSeries.
  "displayName": "A String", # Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
  "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  "metadata": { # Describes metadata for a TensorboardTimeSeries. # Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
    "maxBlobSequenceLength": "A String", # Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
    "maxStep": "A String", # Output only. Max step index of all data points within a TensorboardTimeSeries.
    "maxWallTime": "A String", # Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.
  },
  "name": "A String", # Output only. Name of the TensorboardTimeSeries.
  "pluginData": "A String", # Data of the current plugin, with the size limited to 65KB.
  "pluginName": "A String", # Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
  "updateTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was last updated.
  "valueType": "A String", # Required. Immutable. Type of TensorboardTimeSeries value.
}

delete(name, x__xgafv=None)

Deletes a TensorboardTimeSeries.

Args:
name: string, Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

exportTensorboardTimeSeries(tensorboardTimeSeries, body=None, x__xgafv=None)

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

Args:
  tensorboardTimeSeries: string, 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}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for TensorboardService.ExportTensorboardTimeSeriesData.
  "filter": "A String", # Exports the TensorboardTimeSeries' data that match the filter expression.
  "orderBy": "A String", # Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.
  "pageSize": 42, # The maximum number of data points to return per page. The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000.
  "pageToken": "A String", # A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for TensorboardService.ExportTensorboardTimeSeriesData.
  "nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "timeSeriesDataPoints": [ # The returned time series data points.
    { # A TensorboardTimeSeries data point.
      "blobs": { # One point viewable on a blob metric plot, but mostly just a wrapper message to work around repeated fields can't be used directly within `oneof` fields. # A blob sequence value.
        "values": [ # List of blobs contained within the sequence.
          { # One blob (e.g, image, graph) viewable on a blob metric plot.
            "data": "A String", # Optional. The bytes of the blob is not present unless it's returned by the ReadTensorboardBlobData endpoint.
            "id": "A String", # Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob stored in the Cloud Storage bucket of the consumer project.
          },
        ],
      },
      "scalar": { # One point viewable on a scalar metric plot. # A scalar value.
        "value": 3.14, # Value of the point at this step / timestamp.
      },
      "step": "A String", # Step index of this data point within the run.
      "tensor": { # One point viewable on a tensor metric plot. # A tensor value.
        "value": "A String", # Required. Serialized form of https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto
        "versionNumber": 42, # Optional. Version number of TensorProto used to serialize value.
      },
      "wallTime": "A String", # Wall clock timestamp when this data point is generated by the end user.
    },
  ],
}

exportTensorboardTimeSeries_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

get(name, x__xgafv=None)

Gets a TensorboardTimeSeries.

Args:
  name: string, Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # TensorboardTimeSeries maps to times series produced in training runs
  "createTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was created.
  "description": "A String", # Description of this TensorboardTimeSeries.
  "displayName": "A String", # Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
  "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  "metadata": { # Describes metadata for a TensorboardTimeSeries. # Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
    "maxBlobSequenceLength": "A String", # Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
    "maxStep": "A String", # Output only. Max step index of all data points within a TensorboardTimeSeries.
    "maxWallTime": "A String", # Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.
  },
  "name": "A String", # Output only. Name of the TensorboardTimeSeries.
  "pluginData": "A String", # Data of the current plugin, with the size limited to 65KB.
  "pluginName": "A String", # Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
  "updateTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was last updated.
  "valueType": "A String", # Required. Immutable. Type of TensorboardTimeSeries value.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

Lists TensorboardTimeSeries in a Location.

Args:
  parent: string, Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` (required)
  filter: string, Lists the TensorboardTimeSeries that match the filter expression.
  orderBy: string, Field to use to sort the list.
  pageSize: integer, The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
  pageToken: string, A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.
  readMask: string, Mask specifying which fields to read.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for TensorboardService.ListTensorboardTimeSeries.
  "nextPageToken": "A String", # A token, which can be sent as ListTensorboardTimeSeriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "tensorboardTimeSeries": [ # The TensorboardTimeSeries mathching the request.
    { # TensorboardTimeSeries maps to times series produced in training runs
      "createTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was created.
      "description": "A String", # Description of this TensorboardTimeSeries.
      "displayName": "A String", # Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
      "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
      "metadata": { # Describes metadata for a TensorboardTimeSeries. # Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
        "maxBlobSequenceLength": "A String", # Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
        "maxStep": "A String", # Output only. Max step index of all data points within a TensorboardTimeSeries.
        "maxWallTime": "A String", # Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.
      },
      "name": "A String", # Output only. Name of the TensorboardTimeSeries.
      "pluginData": "A String", # Data of the current plugin, with the size limited to 65KB.
      "pluginName": "A String", # Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
      "updateTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was last updated.
      "valueType": "A String", # Required. Immutable. Type of TensorboardTimeSeries value.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a TensorboardTimeSeries.

Args:
  name: string, Output only. Name of the TensorboardTimeSeries. (required)
  body: object, The request body.
    The object takes the form of:

{ # TensorboardTimeSeries maps to times series produced in training runs
  "createTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was created.
  "description": "A String", # Description of this TensorboardTimeSeries.
  "displayName": "A String", # Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
  "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  "metadata": { # Describes metadata for a TensorboardTimeSeries. # Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
    "maxBlobSequenceLength": "A String", # Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
    "maxStep": "A String", # Output only. Max step index of all data points within a TensorboardTimeSeries.
    "maxWallTime": "A String", # Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.
  },
  "name": "A String", # Output only. Name of the TensorboardTimeSeries.
  "pluginData": "A String", # Data of the current plugin, with the size limited to 65KB.
  "pluginName": "A String", # Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
  "updateTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was last updated.
  "valueType": "A String", # Required. Immutable. Type of TensorboardTimeSeries value.
}

  updateMask: string, 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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # TensorboardTimeSeries maps to times series produced in training runs
  "createTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was created.
  "description": "A String", # Description of this TensorboardTimeSeries.
  "displayName": "A String", # Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
  "etag": "A String", # Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  "metadata": { # Describes metadata for a TensorboardTimeSeries. # Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
    "maxBlobSequenceLength": "A String", # Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
    "maxStep": "A String", # Output only. Max step index of all data points within a TensorboardTimeSeries.
    "maxWallTime": "A String", # Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.
  },
  "name": "A String", # Output only. Name of the TensorboardTimeSeries.
  "pluginData": "A String", # Data of the current plugin, with the size limited to 65KB.
  "pluginName": "A String", # Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
  "updateTime": "A String", # Output only. Timestamp when this TensorboardTimeSeries was last updated.
  "valueType": "A String", # Required. Immutable. Type of TensorboardTimeSeries value.
}

read(tensorboardTimeSeries, filter=None, maxDataPoints=None, x__xgafv=None)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Args:
  tensorboardTimeSeries: string, 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}` (required)
  filter: string, Reads the TensorboardTimeSeries' data that match the filter expression.
  maxDataPoints: integer, The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for TensorboardService.ReadTensorboardTimeSeriesData.
  "timeSeriesData": { # All the data stored in a TensorboardTimeSeries. # The returned time series data.
    "tensorboardTimeSeriesId": "A String", # Required. The ID of the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries' resource name
    "valueType": "A String", # Required. Immutable. The value type of this time series. All the values in this time series data must match this value type.
    "values": [ # Required. Data points in this time series.
      { # A TensorboardTimeSeries data point.
        "blobs": { # One point viewable on a blob metric plot, but mostly just a wrapper message to work around repeated fields can't be used directly within `oneof` fields. # A blob sequence value.
          "values": [ # List of blobs contained within the sequence.
            { # One blob (e.g, image, graph) viewable on a blob metric plot.
              "data": "A String", # Optional. The bytes of the blob is not present unless it's returned by the ReadTensorboardBlobData endpoint.
              "id": "A String", # Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob stored in the Cloud Storage bucket of the consumer project.
            },
          ],
        },
        "scalar": { # One point viewable on a scalar metric plot. # A scalar value.
          "value": 3.14, # Value of the point at this step / timestamp.
        },
        "step": "A String", # Step index of this data point within the run.
        "tensor": { # One point viewable on a tensor metric plot. # A tensor value.
          "value": "A String", # Required. Serialized form of https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto
          "versionNumber": 42, # Optional. Version number of TensorProto used to serialize value.
        },
        "wallTime": "A String", # Wall clock timestamp when this data point is generated by the end user.
      },
    ],
  },
}

readBlobData(timeSeries, blobIds=None, x__xgafv=None)

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.

Args:
  timeSeries: string, Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` (required)
  blobIds: string, IDs of the blobs to read. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for TensorboardService.ReadTensorboardBlobData.
  "blobs": [ # Blob messages containing blob bytes.
    { # One blob (e.g, image, graph) viewable on a blob metric plot.
      "data": "A String", # Optional. The bytes of the blob is not present unless it's returned by the ReadTensorboardBlobData endpoint.
      "id": "A String", # Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob stored in the Cloud Storage bucket of the consumer project.
    },
  ],
}

Vertex AI API . projects . locations . tensorboards . experiments . runs . timeSeries

Instance Methods

Method Details