google-cloud-ai_platform-v1 0.33.0 → 0.34.0

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

@@ -205,6 +205,18 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Time-based Constraint for Study
+        # @!attribute [rw] max_duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Counts the wallclock time passed since the creation of this Study.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Compares the wallclock time to this time. Must use UTC timezone.
+        class StudyTimeConstraint
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Represents specification of a Study.
         # @!attribute [rw] decay_curve_stopping_spec
         #   @return [::Google::Cloud::AIPlatform::V1::StudySpec::DecayCurveAutomatedStoppingSpec]
@@ -232,6 +244,10 @@ module Google
         # @!attribute [rw] measurement_selection_type
         #   @return [::Google::Cloud::AIPlatform::V1::StudySpec::MeasurementSelectionType]
         #     Describe which measurement selection type will be used
+        # @!attribute [rw] study_stopping_config
+        #   @return [::Google::Cloud::AIPlatform::V1::StudySpec::StudyStoppingConfig]
+        #     Conditions for automated stopping of a Study. Enable automated stopping by
+        #     configuring at least one condition.
         class StudySpec
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -561,6 +577,65 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # The configuration (stopping conditions) for automated stopping of a Study.
+          # Conditions include trial budgets, time budgets, and convergence detection.
+          # @!attribute [rw] should_stop_asap
+          #   @return [::Google::Protobuf::BoolValue]
+          #     If true, a Study enters STOPPING_ASAP whenever it would normally enters
+          #     STOPPING state.
+          #
+          #     The bottom line is: set to true if you want to interrupt on-going
+          #     evaluations of Trials as soon as the study stopping condition is met.
+          #     (Please see Study.State documentation for the source of truth).
+          # @!attribute [rw] minimum_runtime_constraint
+          #   @return [::Google::Cloud::AIPlatform::V1::StudyTimeConstraint]
+          #     Each "stopping rule" in this proto specifies an "if" condition. Before
+          #     Vizier would generate a new suggestion, it first checks each specified
+          #     stopping rule, from top to bottom in this list.
+          #     Note that the first few rules (e.g. minimum_runtime_constraint,
+          #     min_num_trials) will prevent other stopping rules from being evaluated
+          #     until they are met. For example, setting `min_num_trials=5` and
+          #     `always_stop_after= 1 hour` means that the Study will ONLY stop after it
+          #     has 5 COMPLETED trials, even if more than an hour has passed since its
+          #     creation. It follows the first applicable rule (whose "if" condition is
+          #     satisfied) to make a stopping decision. If none of the specified rules
+          #     are applicable, then Vizier decides that the study should not stop.
+          #     If Vizier decides that the study should stop, the study enters
+          #     STOPPING state (or STOPPING_ASAP if should_stop_asap = true).
+          #     IMPORTANT: The automatic study state transition happens precisely as
+          #     described above; that is, deleting trials or updating StudyConfig NEVER
+          #     automatically moves the study state back to ACTIVE. If you want to
+          #     _resume_ a Study that was stopped, 1) change the stopping conditions if
+          #     necessary, 2) activate the study, and then 3) ask for suggestions.
+          #     If the specified time or duration has not passed, do not stop the
+          #     study.
+          # @!attribute [rw] maximum_runtime_constraint
+          #   @return [::Google::Cloud::AIPlatform::V1::StudyTimeConstraint]
+          #     If the specified time or duration has passed, stop the study.
+          # @!attribute [rw] min_num_trials
+          #   @return [::Google::Protobuf::Int32Value]
+          #     If there are fewer than this many COMPLETED trials, do not stop the
+          #     study.
+          # @!attribute [rw] max_num_trials
+          #   @return [::Google::Protobuf::Int32Value]
+          #     If there are more than this many trials, stop the study.
+          # @!attribute [rw] max_num_trials_no_progress
+          #   @return [::Google::Protobuf::Int32Value]
+          #     If the objective value has not improved for this many consecutive
+          #     trials, stop the study.
+          #
+          #     WARNING: Effective only for single-objective studies.
+          # @!attribute [rw] max_duration_no_progress
+          #   @return [::Google::Protobuf::Duration]
+          #     If the objective value has not improved for this much time, stop the
+          #     study.
+          #
+          #     WARNING: Effective only for single-objective studies.
+          class StudyStoppingConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The available search algorithms for the Study.
           module Algorithm
             # The default algorithm used by Vertex AI for [hyperparameter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-ai_platform-v1
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -222,6 +222,20 @@ files:
 - lib/google/cloud/ai_platform/v1/endpoint_service/credentials.rb
 - lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb
 - lib/google/cloud/ai_platform/v1/endpoint_service/paths.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/client.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/operations.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/paths.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/feature_online_store_service/paths.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/client.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/operations.rb
+- lib/google/cloud/ai_platform/v1/feature_registry_service/paths.rb
 - lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb
 - lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb
 - lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/credentials.rb
@@ -326,9 +340,19 @@ files:
 - lib/google/cloud/aiplatform/v1/execution_pb.rb
 - lib/google/cloud/aiplatform/v1/explanation_metadata_pb.rb
 - lib/google/cloud/aiplatform/v1/explanation_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_group_pb.rb
 - lib/google/cloud/aiplatform/v1/feature_monitoring_stats_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_admin_service_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_admin_service_services_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_service_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_online_store_service_services_pb.rb
 - lib/google/cloud/aiplatform/v1/feature_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_registry_service_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_registry_service_services_pb.rb
 - lib/google/cloud/aiplatform/v1/feature_selector_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_view_pb.rb
+- lib/google/cloud/aiplatform/v1/feature_view_sync_pb.rb
 - lib/google/cloud/aiplatform/v1/featurestore_monitoring_pb.rb
 - lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb
 - lib/google/cloud/aiplatform/v1/featurestore_online_service_services_pb.rb
@@ -432,8 +456,15 @@ files:
 - proto_docs/google/cloud/aiplatform/v1/explanation.rb
 - proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb
 - proto_docs/google/cloud/aiplatform/v1/feature.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_group.rb
 - proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_online_store.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_online_store_admin_service.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_online_store_service.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_registry_service.rb
 - proto_docs/google/cloud/aiplatform/v1/feature_selector.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_view.rb
+- proto_docs/google/cloud/aiplatform/v1/feature_view_sync.rb
 - proto_docs/google/cloud/aiplatform/v1/featurestore.rb
 - proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb
 - proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb