Class: Google::Cloud::AIPlatform::V1::Trial

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

Overview

A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

Defined Under Namespace

Modules: State Classes: Parameter, WebAccessUrisEntry

Instance Attribute Summary collapse

Instance Attribute Details

#client_id ⇒ ::String (readonly)

Returns Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.

Returns:

  • (::String) —

    Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#custom_job ⇒ ::String (readonly)

Returns Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.

Returns:

  • (::String) —

    Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

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

Returns Output only. Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#final_measurement ⇒ ::Google::Cloud::AIPlatform::V1::Measurement (readonly)

Returns Output only. The final measurement containing the objective value.

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#id ⇒ ::String (readonly)

Returns Output only. The identifier of the Trial assigned by the service.

Returns:

  • (::String) —

    Output only. The identifier of the Trial assigned by the service.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#infeasible_reason ⇒ ::String (readonly)

Returns Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.

Returns:

  • (::String) —

    Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#measurements ⇒ ::Array<::Google::Cloud::AIPlatform::V1::Measurement> (readonly)

Returns Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.

Returns:

  • (::Array<::Google::Cloud::AIPlatform::V1::Measurement>) —

    Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the Trial assigned by the service.

Returns:

  • (::String) —

    Output only. Resource name of the Trial assigned by the service.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

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

Returns Output only. The parameters of the Trial.

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

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

Returns Output only. Time when the Trial was started.

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#state ⇒ ::Google::Cloud::AIPlatform::V1::Trial::State (readonly)

Returns Output only. The detailed state of the Trial.

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end

#web_access_uris ⇒ ::Google::Protobuf::Map{::String => ::String} (readonly)

Returns Output only. URIs for accessing interactive shells (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is true.

The keys are names of each node used for the trial; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool.

The values are the URIs for each node's interactive shell.

Returns:

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

    Output only. URIs for accessing interactive shells (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is true.

    The keys are names of each node used for the trial; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool.

    The values are the URIs for each node's interactive shell.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 131

class Trial
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A message representing a parameter to be tuned.
  # @!attribute [r] parameter_id
  #   @return [::String]
  #     Output only. The ID of the parameter. The parameter should be defined in
  #     [StudySpec's
  #     Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
  # @!attribute [r] value
  #   @return [::Google::Protobuf::Value]
  #     Output only. The value of the parameter.
  #     `number_value` will be set if a parameter defined in StudySpec is
  #     in type 'INTEGER', 'DOUBLE' or 'DISCRETE'.
  #     `string_value` will be set if a parameter defined in StudySpec is
  #     in type 'CATEGORICAL'.
  class Parameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebAccessUrisEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes a Trial state.
  module State
    # The Trial state is unspecified.
    STATE_UNSPECIFIED = 0

    # Indicates that a specific Trial has been requested, but it has not yet
    # been suggested by the service.
    REQUESTED = 1

    # Indicates that the Trial has been suggested.
    ACTIVE = 2

    # Indicates that the Trial should stop according to the service.
    STOPPING = 3

    # Indicates that the Trial is completed successfully.
    SUCCEEDED = 4

    # Indicates that the Trial should not be attempted again.
    # The service will set a Trial to INFEASIBLE when it's done but missing
    # the final_measurement.
    INFEASIBLE = 5
  end
end