1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1beta1
  6. getTrial

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.aiplatform/v1beta1.getTrial

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Gets a Trial.

Using getTrial

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTrial(args: GetTrialArgs, opts?: InvokeOptions): Promise<GetTrialResult>
function getTrialOutput(args: GetTrialOutputArgs, opts?: InvokeOptions): Output<GetTrialResult>
Copy
def get_trial(location: Optional[str] = None,
              project: Optional[str] = None,
              study_id: Optional[str] = None,
              trial_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTrialResult
def get_trial_output(location: Optional[pulumi.Input[str]] = None,
              project: Optional[pulumi.Input[str]] = None,
              study_id: Optional[pulumi.Input[str]] = None,
              trial_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTrialResult]
Copy
func LookupTrial(ctx *Context, args *LookupTrialArgs, opts ...InvokeOption) (*LookupTrialResult, error)
func LookupTrialOutput(ctx *Context, args *LookupTrialOutputArgs, opts ...InvokeOption) LookupTrialResultOutput
Copy

> Note: This function is named LookupTrial in the Go SDK.

public static class GetTrial 
{
    public static Task<GetTrialResult> InvokeAsync(GetTrialArgs args, InvokeOptions? opts = null)
    public static Output<GetTrialResult> Invoke(GetTrialInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTrialResult> getTrial(GetTrialArgs args, InvokeOptions options)
public static Output<GetTrialResult> getTrial(GetTrialArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:aiplatform/v1beta1:getTrial
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
StudyId This property is required. string
TrialId This property is required. string
Project string
Location This property is required. string
StudyId This property is required. string
TrialId This property is required. string
Project string
location This property is required. String
studyId This property is required. String
trialId This property is required. String
project String
location This property is required. string
studyId This property is required. string
trialId This property is required. string
project string
location This property is required. str
study_id This property is required. str
trial_id This property is required. str
project str
location This property is required. String
studyId This property is required. String
trialId This property is required. String
project String

getTrial Result

The following output properties are available:

ClientId string
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.
CustomJob string
The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
EndTime string
Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.
FinalMeasurement Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1MeasurementResponse
The final measurement containing the objective value.
InfeasibleReason string
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
Measurements List<Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1MeasurementResponse>
A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
Name string
Resource name of the Trial assigned by the service.
Parameters List<Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1TrialParameterResponse>
The parameters of the Trial.
StartTime string
Time when the Trial was started.
State string
The detailed state of the Trial.
WebAccessUris Dictionary<string, string>
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.
ClientId string
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.
CustomJob string
The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
EndTime string
Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.
FinalMeasurement GoogleCloudAiplatformV1beta1MeasurementResponse
The final measurement containing the objective value.
InfeasibleReason string
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
Measurements []GoogleCloudAiplatformV1beta1MeasurementResponse
A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
Name string
Resource name of the Trial assigned by the service.
Parameters []GoogleCloudAiplatformV1beta1TrialParameterResponse
The parameters of the Trial.
StartTime string
Time when the Trial was started.
State string
The detailed state of the Trial.
WebAccessUris map[string]string
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.
clientId String
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.
customJob String
The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
endTime String
Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.
finalMeasurement GoogleCloudAiplatformV1beta1MeasurementResponse
The final measurement containing the objective value.
infeasibleReason String
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements List<GoogleCloudAiplatformV1beta1MeasurementResponse>
A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
name String
Resource name of the Trial assigned by the service.
parameters List<GoogleCloudAiplatformV1beta1TrialParameterResponse>
The parameters of the Trial.
startTime String
Time when the Trial was started.
state String
The detailed state of the Trial.
webAccessUris Map<String,String>
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.
clientId string
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.
customJob string
The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
endTime string
Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.
finalMeasurement GoogleCloudAiplatformV1beta1MeasurementResponse
The final measurement containing the objective value.
infeasibleReason string
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements GoogleCloudAiplatformV1beta1MeasurementResponse[]
A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
name string
Resource name of the Trial assigned by the service.
parameters GoogleCloudAiplatformV1beta1TrialParameterResponse[]
The parameters of the Trial.
startTime string
Time when the Trial was started.
state string
The detailed state of the Trial.
webAccessUris {[key: string]: string}
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.
client_id str
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 str
The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
end_time str
Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.
final_measurement GoogleCloudAiplatformV1beta1MeasurementResponse
The final measurement containing the objective value.
infeasible_reason str
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements Sequence[GoogleCloudAiplatformV1beta1MeasurementResponse]
A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
name str
Resource name of the Trial assigned by the service.
parameters Sequence[GoogleCloudAiplatformV1beta1TrialParameterResponse]
The parameters of the Trial.
start_time str
Time when the Trial was started.
state str
The detailed state of the Trial.
web_access_uris Mapping[str, str]
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.
clientId String
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.
customJob String
The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
endTime String
Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.
finalMeasurement Property Map
The final measurement containing the objective value.
infeasibleReason String
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements List<Property Map>
A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
name String
Resource name of the Trial assigned by the service.
parameters List<Property Map>
The parameters of the Trial.
startTime String
Time when the Trial was started.
state String
The detailed state of the Trial.
webAccessUris Map<String>
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.

Supporting Types

GoogleCloudAiplatformV1beta1MeasurementMetricResponse

MetricId This property is required. string
The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
Value This property is required. double
The value for this metric.
MetricId This property is required. string
The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
Value This property is required. float64
The value for this metric.
metricId This property is required. String
The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
value This property is required. Double
The value for this metric.
metricId This property is required. string
The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
value This property is required. number
The value for this metric.
metric_id This property is required. str
The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
value This property is required. float
The value for this metric.
metricId This property is required. String
The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
value This property is required. Number
The value for this metric.

GoogleCloudAiplatformV1beta1MeasurementResponse

ElapsedDuration This property is required. string
Time that the Trial has been running at the point of this Measurement.
Metrics This property is required. List<Pulumi.GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleCloudAiplatformV1beta1MeasurementMetricResponse>
A list of metrics got by evaluating the objective functions using suggested Parameter values.
StepCount This property is required. string
The number of steps the machine learning model has been trained for. Must be non-negative.
ElapsedDuration This property is required. string
Time that the Trial has been running at the point of this Measurement.
Metrics This property is required. []GoogleCloudAiplatformV1beta1MeasurementMetricResponse
A list of metrics got by evaluating the objective functions using suggested Parameter values.
StepCount This property is required. string
The number of steps the machine learning model has been trained for. Must be non-negative.
elapsedDuration This property is required. String
Time that the Trial has been running at the point of this Measurement.
metrics This property is required. List<GoogleCloudAiplatformV1beta1MeasurementMetricResponse>
A list of metrics got by evaluating the objective functions using suggested Parameter values.
stepCount This property is required. String
The number of steps the machine learning model has been trained for. Must be non-negative.
elapsedDuration This property is required. string
Time that the Trial has been running at the point of this Measurement.
metrics This property is required. GoogleCloudAiplatformV1beta1MeasurementMetricResponse[]
A list of metrics got by evaluating the objective functions using suggested Parameter values.
stepCount This property is required. string
The number of steps the machine learning model has been trained for. Must be non-negative.
elapsed_duration This property is required. str
Time that the Trial has been running at the point of this Measurement.
metrics This property is required. Sequence[GoogleCloudAiplatformV1beta1MeasurementMetricResponse]
A list of metrics got by evaluating the objective functions using suggested Parameter values.
step_count This property is required. str
The number of steps the machine learning model has been trained for. Must be non-negative.
elapsedDuration This property is required. String
Time that the Trial has been running at the point of this Measurement.
metrics This property is required. List<Property Map>
A list of metrics got by evaluating the objective functions using suggested Parameter values.
stepCount This property is required. String
The number of steps the machine learning model has been trained for. Must be non-negative.

GoogleCloudAiplatformV1beta1TrialParameterResponse

ParameterId This property is required. string
The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
Value This property is required. object
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'.
ParameterId This property is required. string
The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
Value This property is required. interface{}
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'.
parameterId This property is required. String
The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
value This property is required. Object
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'.
parameterId This property is required. string
The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
value This property is required. any
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'.
parameter_id This property is required. str
The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
value This property is required. Any
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'.
parameterId This property is required. String
The ID of the parameter. The parameter should be defined in StudySpec's Parameters.
value This property is required. Any
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'.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi