Class Trial (1.36.4)

  Trial 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

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.

Attributes

Name

Description

name

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

id

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

state

 google.cloud.aiplatform_v1.types.Trial.State

Output only. The detailed state of the Trial.

parameters

MutableSequence[ google.cloud.aiplatform_v1.types.Trial.Parameter 
]

Output only. The parameters of the Trial.

final_measurement

 google.cloud.aiplatform_v1.types.Measurement

Output only. The final measurement containing the objective value.

measurements

MutableSequence[ google.cloud.aiplatform_v1.types.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.

start_time

google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the Trial was started.

end_time

google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the Trial's status changed to SUCCEEDED or INFEASIBLE .

client_id

str
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.

infeasible_reason

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

custom_job

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

web_access_uris

MutableMapping[str, str]
Output only. URIs for accessing `interactive shells

Classes

Parameter

  Parameter 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

A message representing a parameter to be tuned.

State

  State 
 ( 
 value 
 )

Describes a Trial state.

Values: STATE_UNSPECIFIED (0): The Trial state is unspecified. REQUESTED (1): Indicates that a specific Trial has been requested, but it has not yet been suggested by the service. ACTIVE (2): Indicates that the Trial has been suggested. STOPPING (3): Indicates that the Trial should stop according to the service. SUCCEEDED (4): Indicates that the Trial is completed successfully. INFEASIBLE (5): 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.

WebAccessUrisEntry

  WebAccessUrisEntry 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

The abstract base class for a message.

Parameters

Name

Description

kwargs

dict

Keys and values corresponding to the fields of the message.

mapping

Union[dict, .Message 
]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields

Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Methods

Trial

  Trial 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

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.