1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.aiplatform.v1beta1; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/protobuf/timestamp.proto"; 22 23option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1"; 24option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb"; 25option java_multiple_files = true; 26option java_outer_classname = "TensorboardTimeSeriesProto"; 27option java_package = "com.google.cloud.aiplatform.v1beta1"; 28option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; 29option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; 30 31// TensorboardTimeSeries maps to times series produced in training runs 32message TensorboardTimeSeries { 33 option (google.api.resource) = { 34 type: "aiplatform.googleapis.com/TensorboardTimeSeries" 35 pattern: "projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}" 36 }; 37 38 // Describes metadata for a TensorboardTimeSeries. 39 message Metadata { 40 // Output only. Max step index of all data points within a 41 // TensorboardTimeSeries. 42 int64 max_step = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 43 44 // Output only. Max wall clock timestamp of all data points within a 45 // TensorboardTimeSeries. 46 google.protobuf.Timestamp max_wall_time = 2 47 [(google.api.field_behavior) = OUTPUT_ONLY]; 48 49 // Output only. The largest blob sequence length (number of blobs) of all 50 // data points in this time series, if its ValueType is BLOB_SEQUENCE. 51 int64 max_blob_sequence_length = 3 52 [(google.api.field_behavior) = OUTPUT_ONLY]; 53 } 54 55 // An enum representing the value type of a TensorboardTimeSeries. 56 enum ValueType { 57 // The value type is unspecified. 58 VALUE_TYPE_UNSPECIFIED = 0; 59 60 // Used for TensorboardTimeSeries that is a list of scalars. 61 // E.g. accuracy of a model over epochs/time. 62 SCALAR = 1; 63 64 // Used for TensorboardTimeSeries that is a list of tensors. 65 // E.g. histograms of weights of layer in a model over epoch/time. 66 TENSOR = 2; 67 68 // Used for TensorboardTimeSeries that is a list of blob sequences. 69 // E.g. set of sample images with labels over epochs/time. 70 BLOB_SEQUENCE = 3; 71 } 72 73 // Output only. Name of the TensorboardTimeSeries. 74 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 75 76 // Required. User provided name of this TensorboardTimeSeries. 77 // This value should be unique among all TensorboardTimeSeries resources 78 // belonging to the same TensorboardRun resource (parent resource). 79 string display_name = 2 [(google.api.field_behavior) = REQUIRED]; 80 81 // Description of this TensorboardTimeSeries. 82 string description = 3; 83 84 // Required. Immutable. Type of TensorboardTimeSeries value. 85 ValueType value_type = 4 [ 86 (google.api.field_behavior) = REQUIRED, 87 (google.api.field_behavior) = IMMUTABLE 88 ]; 89 90 // Output only. Timestamp when this TensorboardTimeSeries was created. 91 google.protobuf.Timestamp create_time = 5 92 [(google.api.field_behavior) = OUTPUT_ONLY]; 93 94 // Output only. Timestamp when this TensorboardTimeSeries was last updated. 95 google.protobuf.Timestamp update_time = 6 96 [(google.api.field_behavior) = OUTPUT_ONLY]; 97 98 // Used to perform a consistent read-modify-write updates. If not set, a blind 99 // "overwrite" update happens. 100 string etag = 7; 101 102 // Immutable. Name of the plugin this time series pertain to. Such as Scalar, 103 // Tensor, Blob 104 string plugin_name = 8 [(google.api.field_behavior) = IMMUTABLE]; 105 106 // Data of the current plugin, with the size limited to 65KB. 107 bytes plugin_data = 9; 108 109 // Output only. Scalar, Tensor, or Blob metadata for this 110 // TensorboardTimeSeries. 111 Metadata metadata = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; 112} 113