Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. Trial

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
pulumi/pulumi-google-native

google-native.aiplatform/v1.Trial

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
pulumi/pulumi-google-native

Adds a user provided Trial to a Study. Auto-naming is currently not supported for this resource.

Create Trial Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Trial(name: string, args: TrialArgs, opts?: CustomResourceOptions);
@overload
def Trial(resource_name: str,
          args: TrialArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Trial(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          study_id: Optional[str] = None,
          location: Optional[str] = None,
          project: Optional[str] = None)
func NewTrial(ctx *Context, name string, args TrialArgs, opts ...ResourceOption) (*Trial, error)
public Trial(string name, TrialArgs args, CustomResourceOptions? opts = null)
public Trial(String name, TrialArgs args)
public Trial(String name, TrialArgs args, CustomResourceOptions options)

type: google-native:aiplatform/v1:Trial
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TrialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TrialArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TrialArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TrialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TrialArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var trialResource = new GoogleNative.Aiplatform.V1.Trial("trialResource", new()
{
    StudyId = "string",
    Location = "string",
    Project = "string",
});
Copy
example, err := aiplatform.NewTrial(ctx, "trialResource", &aiplatform.TrialArgs{
	StudyId:  pulumi.String("string"),
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
})
Copy
var trialResource = new Trial("trialResource", TrialArgs.builder()
    .studyId("string")
    .location("string")
    .project("string")
    .build());
Copy
trial_resource = google_native.aiplatform.v1.Trial("trialResource",
    study_id="string",
    location="string",
    project="string")
Copy
const trialResource = new google_native.aiplatform.v1.Trial("trialResource", {
    studyId: "string",
    location: "string",
    project: "string",
});
Copy
type: google-native:aiplatform/v1:Trial
properties:
    location: string
    project: string
    studyId: string
Copy

Trial Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Trial resource accepts the following input properties:

StudyId
This property is required.
Changes to this property will trigger replacement.
string
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
StudyId
This property is required.
Changes to this property will trigger replacement.
string
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
studyId
This property is required.
Changes to this property will trigger replacement.
String
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
studyId
This property is required.
Changes to this property will trigger replacement.
string
location Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. string
study_id
This property is required.
Changes to this property will trigger replacement.
str
location Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. str
studyId
This property is required.
Changes to this property will trigger replacement.
String
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String

Outputs

All input properties are implicitly available as output properties. Additionally, the Trial resource produces the following output properties:

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.V1.Outputs.GoogleCloudAiplatformV1MeasurementResponse
The final measurement containing the objective value.
Id string
The provider-assigned unique ID for this managed resource.
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.V1.Outputs.GoogleCloudAiplatformV1MeasurementResponse>
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.V1.Outputs.GoogleCloudAiplatformV1TrialParameterResponse>
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 GoogleCloudAiplatformV1MeasurementResponse
The final measurement containing the objective value.
Id string
The provider-assigned unique ID for this managed resource.
InfeasibleReason string
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
Measurements []GoogleCloudAiplatformV1MeasurementResponse
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 []GoogleCloudAiplatformV1TrialParameterResponse
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 GoogleCloudAiplatformV1MeasurementResponse
The final measurement containing the objective value.
id String
The provider-assigned unique ID for this managed resource.
infeasibleReason String
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements List<GoogleCloudAiplatformV1MeasurementResponse>
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<GoogleCloudAiplatformV1TrialParameterResponse>
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 GoogleCloudAiplatformV1MeasurementResponse
The final measurement containing the objective value.
id string
The provider-assigned unique ID for this managed resource.
infeasibleReason string
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements GoogleCloudAiplatformV1MeasurementResponse[]
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 GoogleCloudAiplatformV1TrialParameterResponse[]
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 GoogleCloudAiplatformV1MeasurementResponse
The final measurement containing the objective value.
id str
The provider-assigned unique ID for this managed resource.
infeasible_reason str
A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements Sequence[GoogleCloudAiplatformV1MeasurementResponse]
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[GoogleCloudAiplatformV1TrialParameterResponse]
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.
id String
The provider-assigned unique ID for this managed resource.
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

GoogleCloudAiplatformV1MeasurementMetricResponse
, GoogleCloudAiplatformV1MeasurementMetricResponseArgs

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.

GoogleCloudAiplatformV1MeasurementResponse
, GoogleCloudAiplatformV1MeasurementResponseArgs

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.V1.Inputs.GoogleCloudAiplatformV1MeasurementMetricResponse>
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. []GoogleCloudAiplatformV1MeasurementMetricResponse
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<GoogleCloudAiplatformV1MeasurementMetricResponse>
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. GoogleCloudAiplatformV1MeasurementMetricResponse[]
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[GoogleCloudAiplatformV1MeasurementMetricResponse]
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.

GoogleCloudAiplatformV1TrialParameterResponse
, GoogleCloudAiplatformV1TrialParameterResponseArgs

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
pulumi/pulumi-google-native