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.v1; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/protobuf/timestamp.proto"; 22 23option csharp_namespace = "Google.Cloud.AIPlatform.V1"; 24option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb"; 25option java_multiple_files = true; 26option java_outer_classname = "TensorboardExperimentProto"; 27option java_package = "com.google.cloud.aiplatform.v1"; 28option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; 29option ruby_package = "Google::Cloud::AIPlatform::V1"; 30 31// A TensorboardExperiment is a group of TensorboardRuns, that are typically the 32// results of a training job run, in a Tensorboard. 33message TensorboardExperiment { 34 option (google.api.resource) = { 35 type: "aiplatform.googleapis.com/TensorboardExperiment" 36 pattern: "projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}" 37 }; 38 39 // Output only. Name of the TensorboardExperiment. 40 // Format: 41 // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` 42 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 43 44 // User provided name of this TensorboardExperiment. 45 string display_name = 2; 46 47 // Description of this TensorboardExperiment. 48 string description = 3; 49 50 // Output only. Timestamp when this TensorboardExperiment was created. 51 google.protobuf.Timestamp create_time = 4 52 [(google.api.field_behavior) = OUTPUT_ONLY]; 53 54 // Output only. Timestamp when this TensorboardExperiment was last updated. 55 google.protobuf.Timestamp update_time = 5 56 [(google.api.field_behavior) = OUTPUT_ONLY]; 57 58 // The labels with user-defined metadata to organize your 59 // TensorboardExperiment. 60 // 61 // Label keys and values cannot be longer than 64 characters 62 // (Unicode codepoints), can only contain lowercase letters, numeric 63 // characters, underscores and dashes. International characters are allowed. 64 // No more than 64 user labels can be associated with one Dataset (System 65 // labels are excluded). 66 // 67 // See https://goo.gl/xmQnxf for more information and examples of labels. 68 // System reserved label keys are prefixed with `aiplatform.googleapis.com/` 69 // and are immutable. The following system labels exist for each Dataset: 70 // 71 // * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its 72 // value is the 73 // [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] 74 // title. 75 map<string, string> labels = 6; 76 77 // Used to perform consistent read-modify-write updates. If not set, a blind 78 // "overwrite" update happens. 79 string etag = 7; 80 81 // Immutable. Source of the TensorboardExperiment. Example: a custom training 82 // job. 83 string source = 8 [(google.api.field_behavior) = IMMUTABLE]; 84} 85