google-cloud-ai_platform-v1 0.1.0

data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # All the data stored in a TensorboardTimeSeries.
+        # @!attribute [rw] tensorboard_time_series_id
+        #   @return [::String]
+        #     Required. The ID of the TensorboardTimeSeries, which will become the final component
+        #     of the TensorboardTimeSeries' resource name
+        # @!attribute [rw] value_type
+        #   @return [::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries::ValueType]
+        #     Required. Immutable. The value type of this time series. All the values in this time series data
+        #     must match this value type.
+        # @!attribute [rw] values
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>]
+        #     Required. Data points in this time series.
+        class TimeSeriesData
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A TensorboardTimeSeries data point.
+        # @!attribute [rw] scalar
+        #   @return [::Google::Cloud::AIPlatform::V1::Scalar]
+        #     A scalar value.
+        # @!attribute [rw] tensor
+        #   @return [::Google::Cloud::AIPlatform::V1::TensorboardTensor]
+        #     A tensor value.
+        # @!attribute [rw] blobs
+        #   @return [::Google::Cloud::AIPlatform::V1::TensorboardBlobSequence]
+        #     A blob sequence value.
+        # @!attribute [rw] wall_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Wall clock timestamp when this data point is generated by the end user.
+        # @!attribute [rw] step
+        #   @return [::Integer]
+        #     Step index of this data point within the run.
+        class TimeSeriesDataPoint
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # One point viewable on a scalar metric plot.
+        # @!attribute [rw] value
+        #   @return [::Float]
+        #     Value of the point at this step / timestamp.
+        class Scalar
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # One point viewable on a tensor metric plot.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     Required. Serialized form of
+        #     https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto
+        # @!attribute [rw] version_number
+        #   @return [::Integer]
+        #     Optional. Version number of TensorProto used to serialize {::Google::Cloud::AIPlatform::V1::TensorboardTensor#value value}.
+        class TensorboardTensor
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [rw] values
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::TensorboardBlob>]
+        #     List of blobs contained within the sequence.
+        class TensorboardBlobSequence
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # One blob (e.g, image, graph) viewable on a blob metric plot.
+        # @!attribute [r] id
+        #   @return [::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.
+        # @!attribute [rw] data
+        #   @return [::String]
+        #     Optional. The bytes of the blob is not present unless it's returned by the
+        #     ReadTensorboardBlobData endpoint.
+        class TensorboardBlob
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # A TensorboardExperiment is a group of TensorboardRuns, that are typically the
+        # results of a training job run, in a Tensorboard.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Name of the TensorboardExperiment.
+        #     Format:
+        #     `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     User provided name of this TensorboardExperiment.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of this TensorboardExperiment.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this TensorboardExperiment was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this TensorboardExperiment was last updated.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The labels with user-defined metadata to organize your Datasets.
+        #
+        #     Label keys and values can be no longer than 64 characters
+        #     (Unicode codepoints), can only contain lowercase letters, numeric
+        #     characters, underscores and dashes. International characters are allowed.
+        #     No more than 64 user labels can be associated with one Dataset (System
+        #     labels are excluded).
+        #
+        #     See https://goo.gl/xmQnxf for more information and examples of labels.
+        #     System reserved label keys are prefixed with "aiplatform.googleapis.com/"
+        #     and are immutable. Following system labels exist for each Dataset:
+        #     * "aiplatform.googleapis.com/dataset_metadata_schema":
+        #       - output only, its value is the
+        #       [metadata_schema's][metadata_schema_uri] title.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Used to perform consistent read-modify-write updates. If not set, a blind
+        #     "overwrite" update happens.
+        # @!attribute [rw] source
+        #   @return [::String]
+        #     Immutable. Source of the TensorboardExperiment. Example: a custom training job.
+        class TensorboardExperiment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/tensorboard_run.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # TensorboardRun maps to a specific execution of a training job with a given
+        # set of hyperparameter values, model definition, dataset, etc
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Name of the TensorboardRun.
+        #     Format:
+        #     `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. User provided name of this TensorboardRun.
+        #     This value must be unique among all TensorboardRuns
+        #     belonging to the same parent TensorboardExperiment.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of this TensorboardRun.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this TensorboardRun was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this TensorboardRun was last updated.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The labels with user-defined metadata to organize your TensorboardRuns.
+        #
+        #     This field will be used to filter and visualize Runs in the Tensorboard UI.
+        #     For example, a Vertex AI training job can set a label
+        #     aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
+        #     within that job. An end user can set a label experiment_id=xxxxx for all
+        #     the runs produced in a Jupyter notebook. These runs can be grouped by a
+        #     label value and visualized together in the Tensorboard UI.
+        #
+        #     Label keys and values can be no longer than 64 characters
+        #     (Unicode codepoints), can only contain lowercase letters, numeric
+        #     characters, underscores and dashes. International characters are allowed.
+        #     No more than 64 user labels can be associated with one TensorboardRun
+        #     (System labels are excluded).
+        #
+        #     See https://goo.gl/xmQnxf for more information and examples of labels.
+        #     System reserved label keys are prefixed with "aiplatform.googleapis.com/"
+        #     and are immutable.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Used to perform a consistent read-modify-write updates. If not set, a blind
+        #     "overwrite" update happens.
+        class TensorboardRun
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end