google-apis-aiplatform_v1 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 541f2b095bb7e53c7e59602a4698786a84360a650575eb53f0dba6af63c25334
-  data.tar.gz: 99d893179df77a2c766e7488c734de5cdf4dbd181f966b348f222d4e0ab837fd
+  metadata.gz: a339acc9e2792d9aa7013da1b553c8c1ca02f20de7757eef4d32ab8ff77bfa7f
+  data.tar.gz: 18fc1b6da92d7fcf3a7c6260d0f6f87bfa28161835ba26099d8fba4cccbbf5d3
 SHA512:
-  metadata.gz: 317660ccea0203847e117d3625ba428f8ba183b9898ff8fbe9c04a54a5fb709b72e9513927d112b722777c8b2981602a163debe7318aee9fe202693d4b84913b
-  data.tar.gz: '0499fcd874ef1f7ca35a5d1b65724e029a516cc8b43f1e58a273b1a525a0cc849ceb6138a3209584ba5cb1b6e526daff55066ea4497eedc276e7130d1a99b605'
+  metadata.gz: e81f4475ecb2435a3ba04299ed691d59c1d60761f58a532d8b4242e2ec165f3207859f676c470ab0644092508224cd991196c4097b80df27189ee2d1935cba7d
+  data.tar.gz: ae9e5be153a1084f0cfa16b7d87f64b1452a2d4ba05a43a54d8aa798e9cac12e194121aacea0d9a7069efbbc99e6e4bb567c0530d1aefa4664d79fab1eb364ee

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-aiplatform_v1
 
+### v0.5.0 (2023-10-29)
+
+* Regenerated from discovery document revision 20231023
+
 ### v0.4.0 (2023-10-22)
 
 * Regenerated from discovery document revision 20231012

data/lib/google/apis/aiplatform_v1/classes.rb

@@ -2774,9 +2774,8 @@ module Google
         attr_accessor :network
       
         # The ID of the location to store protected artifacts. e.g. us-central1.
-        # Populate only when the location is different than CustomJob location. For
-        # unprotected artifacts, the value of this field is ignored. List of supported
-        # locations: https://cloud.google.com/vertex-ai/docs/general/locations
+        # Populate only when the location is different than CustomJob location. List of
+        # supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
         # Corresponds to the JSON property `protectedArtifactLocationId`
         # @return [String]
         attr_accessor :protected_artifact_location_id
@@ -21363,7 +21362,7 @@ module Google
         end
       end
       
-      # A message representing a Study.
+      # A message representing a Study. Next id: 12
       class GoogleCloudAiplatformV1Study
         include Google::Apis::Core::Hashable
       
@@ -21476,6 +21475,12 @@ module Google
         # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecParameterSpec>]
         attr_accessor :parameters
       
+        # The configuration (stopping conditions) for automated stopping of a Study.
+        # Conditions include trial budgets, time budgets, and convergence detection.
+        # Corresponds to the JSON property `studyStoppingConfig`
+        # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecStudyStoppingConfig]
+        attr_accessor :study_stopping_config
+      
         def initialize(**args)
            update!(**args)
         end
@@ -21490,6 +21495,7 @@ module Google
           @metrics = args[:metrics] if args.key?(:metrics)
           @observation_noise = args[:observation_noise] if args.key?(:observation_noise)
           @parameters = args[:parameters] if args.key?(:parameters)
+          @study_stopping_config = args[:study_stopping_config] if args.key?(:study_stopping_config)
         end
       end
       
@@ -21973,6 +21979,93 @@ module Google
         end
       end
       
+      # The configuration (stopping conditions) for automated stopping of a Study.
+      # Conditions include trial budgets, time budgets, and convergence detection.
+      class GoogleCloudAiplatformV1StudySpecStudyStoppingConfig
+        include Google::Apis::Core::Hashable
+      
+        # If the objective value has not improved for this much time, stop the study.
+        # WARNING: Effective only for single-objective studies.
+        # Corresponds to the JSON property `maxDurationNoProgress`
+        # @return [String]
+        attr_accessor :max_duration_no_progress
+      
+        # If there are more than this many trials, stop the study.
+        # Corresponds to the JSON property `maxNumTrials`
+        # @return [Fixnum]
+        attr_accessor :max_num_trials
+      
+        # If the objective value has not improved for this many consecutive trials, stop
+        # the study. WARNING: Effective only for single-objective studies.
+        # Corresponds to the JSON property `maxNumTrialsNoProgress`
+        # @return [Fixnum]
+        attr_accessor :max_num_trials_no_progress
+      
+        # Time-based Constraint for Study
+        # Corresponds to the JSON property `maximumRuntimeConstraint`
+        # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint]
+        attr_accessor :maximum_runtime_constraint
+      
+        # If there are fewer than this many COMPLETED trials, do not stop the study.
+        # Corresponds to the JSON property `minNumTrials`
+        # @return [Fixnum]
+        attr_accessor :min_num_trials
+      
+        # Time-based Constraint for Study
+        # Corresponds to the JSON property `minimumRuntimeConstraint`
+        # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint]
+        attr_accessor :minimum_runtime_constraint
+      
+        # 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).
+        # Corresponds to the JSON property `shouldStopAsap`
+        # @return [Boolean]
+        attr_accessor :should_stop_asap
+        alias_method :should_stop_asap?, :should_stop_asap
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @max_duration_no_progress = args[:max_duration_no_progress] if args.key?(:max_duration_no_progress)
+          @max_num_trials = args[:max_num_trials] if args.key?(:max_num_trials)
+          @max_num_trials_no_progress = args[:max_num_trials_no_progress] if args.key?(:max_num_trials_no_progress)
+          @maximum_runtime_constraint = args[:maximum_runtime_constraint] if args.key?(:maximum_runtime_constraint)
+          @min_num_trials = args[:min_num_trials] if args.key?(:min_num_trials)
+          @minimum_runtime_constraint = args[:minimum_runtime_constraint] if args.key?(:minimum_runtime_constraint)
+          @should_stop_asap = args[:should_stop_asap] if args.key?(:should_stop_asap)
+        end
+      end
+      
+      # Time-based Constraint for Study
+      class GoogleCloudAiplatformV1StudyTimeConstraint
+        include Google::Apis::Core::Hashable
+      
+        # Compares the wallclock time to this time. Must use UTC timezone.
+        # Corresponds to the JSON property `endTime`
+        # @return [String]
+        attr_accessor :end_time
+      
+        # Counts the wallclock time passed since the creation of this Study.
+        # Corresponds to the JSON property `maxDuration`
+        # @return [String]
+        attr_accessor :max_duration
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end_time = args[:end_time] if args.key?(:end_time)
+          @max_duration = args[:max_duration] if args.key?(:max_duration)
+        end
+      end
+      
       # Details of operations that perform Trials suggestion.
       class GoogleCloudAiplatformV1SuggestTrialsMetadata
         include Google::Apis::Core::Hashable

data/lib/google/apis/aiplatform_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AiplatformV1
       # Version of the google-apis-aiplatform_v1 gem
-      GEM_VERSION = "0.4.0"
+      GEM_VERSION = "0.5.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231012"
+      REVISION = "20231023"
     end
   end
 end

data/lib/google/apis/aiplatform_v1/representations.rb

@@ -3604,6 +3604,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudAiplatformV1StudySpecStudyStoppingConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudAiplatformV1StudyTimeConstraint
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudAiplatformV1SuggestTrialsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -9866,6 +9878,8 @@ module Google
           property :observation_noise, as: 'observationNoise'
           collection :parameters, as: 'parameters', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecParameterSpec, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecParameterSpec::Representation
       
+          property :study_stopping_config, as: 'studyStoppingConfig', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecStudyStoppingConfig, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecStudyStoppingConfig::Representation
+      
         end
       end
       
@@ -10000,6 +10014,29 @@ module Google
         end
       end
       
+      class GoogleCloudAiplatformV1StudySpecStudyStoppingConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :max_duration_no_progress, as: 'maxDurationNoProgress'
+          property :max_num_trials, as: 'maxNumTrials'
+          property :max_num_trials_no_progress, as: 'maxNumTrialsNoProgress'
+          property :maximum_runtime_constraint, as: 'maximumRuntimeConstraint', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint::Representation
+      
+          property :min_num_trials, as: 'minNumTrials'
+          property :minimum_runtime_constraint, as: 'minimumRuntimeConstraint', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint::Representation
+      
+          property :should_stop_asap, as: 'shouldStopAsap'
+        end
+      end
+      
+      class GoogleCloudAiplatformV1StudyTimeConstraint
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_time, as: 'endTime'
+          property :max_duration, as: 'maxDuration'
+        end
+      end
+      
       class GoogleCloudAiplatformV1SuggestTrialsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-aiplatform_v1
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.4.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.5.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1
 post_install_message: 
 rdoc_options: []