# Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Trial (v1.44.0)

1.43.0 (latest) 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.1 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.1 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Trial.

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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #client_id

    def client_id() -> ::String

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

### #custom_job

    def custom_job() -> ::String

**Returns**

- (::String) --- Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.

### #end_time

    def end_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Protobuf-Timestamp)) --- Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.

### #final_measurement

    def final_measurement() -> ::Google::Cloud::AIPlatform::V1::Measurement

**Returns**

- ([::Google::Cloud::AIPlatform::V1::Measurement](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Measurement)) --- Output only. The final measurement containing the objective value.

### #id

    def id() -> ::String

**Returns**

- (::String) --- Output only. The identifier of the Trial assigned by the service.

### #infeasible_reason

    def infeasible_reason() -> ::String

**Returns**

- (::String) --- Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`.

### #measurements

    def measurements() -> ::Array<::Google::Cloud::AIPlatform::V1::Measurement>

**Returns**

- (::Array\<[::Google::Cloud::AIPlatform::V1::Measurement](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/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.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Output only. Resource name of the Trial assigned by the service.

### #parameters

    def parameters() -> ::Array<::Google::Cloud::AIPlatform::V1::Trial::Parameter>

**Returns**

- (::Array\<[::Google::Cloud::AIPlatform::V1::Trial::Parameter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial-Parameter)\>) --- Output only. The parameters of the Trial.

### #start_time

    def start_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Protobuf-Timestamp)) --- Output only. Time when the Trial was started.

### #state

    def state() -> ::Google::Cloud::AIPlatform::V1::Trial::State

**Returns**

- ([::Google::Cloud::AIPlatform::V1::Trial::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-Trial-State)) --- Output only. The detailed state of the Trial.

### #web_access_uris

    def web_access_uris() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Output only. URIs for accessing [interactive
  shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a [HyperparameterTuningJob](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-HyperparameterTuningJob "Google::Cloud::AIPlatform::V1::HyperparameterTuningJob (class)") and the job's [trial_job_spec.enable_web_access](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ai_platform-v1/latest/Google-Cloud-AIPlatform-V1-CustomJobSpec#Google__Cloud__AIPlatform__V1__CustomJobSpec_enable_web_access_instance_ "Google::Cloud::AIPlatform::V1::CustomJobSpec#enable_web_access (method)") 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.