Class: Google::Cloud::AIPlatform::V1::HyperparameterTuningJob

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb

Overview

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the HyperparameterTuningJob was created.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#display_name ⇒ ::String

Returns Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.

Returns:

  • (::Google::Cloud::AIPlatform::V1::EncryptionSpec) —

    Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Returns:

  • (::Google::Rpc::Status) —

    Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The labels with user-defined metadata to organize HyperparameterTuningJobs.

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.

See https://goo.gl/xmQnxf for more information and examples of labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The labels with user-defined metadata to organize HyperparameterTuningJobs.

    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.

    See https://goo.gl/xmQnxf for more information and examples of labels.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#max_failed_trial_count ⇒ ::Integer

Returns The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.

If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.

Returns:

  • (::Integer) —

    The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.

    If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#max_trial_count ⇒ ::Integer

Returns Required. The desired total number of Trials.

Returns:

  • (::Integer) —

    Required. The desired total number of Trials.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the HyperparameterTuningJob.

Returns:

  • (::String) —

    Output only. Resource name of the HyperparameterTuningJob.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#parallel_trial_count ⇒ ::Integer

Returns Required. The desired number of Trials to run in parallel.

Returns:

  • (::Integer) —

    Required. The desired number of Trials to run in parallel.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#state ⇒ ::Google::Cloud::AIPlatform::V1::JobState (readonly)

Returns Output only. The detailed state of the job.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#study_spec ⇒ ::Google::Cloud::AIPlatform::V1::StudySpec

Returns Required. Study configuration of the HyperparameterTuningJob.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#trial_job_spec ⇒ ::Google::Cloud::AIPlatform::V1::CustomJobSpec

Returns Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#trials ⇒ ::Array<::Google::Cloud::AIPlatform::V1::Trial> (readonly)

Returns Output only. Trials of the HyperparameterTuningJob.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the HyperparameterTuningJob was most recently updated.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb', line 101

class HyperparameterTuningJob
  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