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 = "TensorboardRunProto"; 27option java_package = "com.google.cloud.aiplatform.v1beta1"; 28option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; 29option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; 30 31// TensorboardRun maps to a specific execution of a training job with a given 32// set of hyperparameter values, model definition, dataset, etc 33message TensorboardRun { 34 option (google.api.resource) = { 35 type: "aiplatform.googleapis.com/TensorboardRun" 36 pattern: "projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}" 37 }; 38 39 // Output only. Name of the TensorboardRun. 40 // Format: 41 // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` 42 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 43 44 // Required. User provided name of this TensorboardRun. 45 // This value must be unique among all TensorboardRuns 46 // belonging to the same parent TensorboardExperiment. 47 string display_name = 2 [(google.api.field_behavior) = REQUIRED]; 48 49 // Description of this TensorboardRun. 50 string description = 3; 51 52 // Output only. Timestamp when this TensorboardRun was created. 53 google.protobuf.Timestamp create_time = 6 54 [(google.api.field_behavior) = OUTPUT_ONLY]; 55 56 // Output only. Timestamp when this TensorboardRun was last updated. 57 google.protobuf.Timestamp update_time = 7 58 [(google.api.field_behavior) = OUTPUT_ONLY]; 59 60 // The labels with user-defined metadata to organize your TensorboardRuns. 61 // 62 // This field will be used to filter and visualize Runs in the Tensorboard UI. 63 // For example, a Vertex AI training job can set a label 64 // aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created 65 // within that job. An end user can set a label experiment_id=xxxxx for all 66 // the runs produced in a Jupyter notebook. These runs can be grouped by a 67 // label value and visualized together in the Tensorboard UI. 68 // 69 // Label keys and values can be no longer than 64 characters 70 // (Unicode codepoints), can only contain lowercase letters, numeric 71 // characters, underscores and dashes. International characters are allowed. 72 // No more than 64 user labels can be associated with one TensorboardRun 73 // (System labels are excluded). 74 // 75 // See https://goo.gl/xmQnxf for more information and examples of labels. 76 // System reserved label keys are prefixed with "aiplatform.googleapis.com/" 77 // and are immutable. 78 map<string, string> labels = 8; 79 80 // Used to perform a consistent read-modify-write updates. If not set, a blind 81 // "overwrite" update happens. 82 string etag = 9; 83} 84