Trial class

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

Constructors

Trial(String name, {TrialArgs? args, CustomResourceOptions? options})

Creates a new Trial. name The Pulumi resource name. args Arguments used to configure this Trial. The set of arguments for Trial. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

clientId ↔ Output<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.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

customJob ↔ Output<String>

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

late, final

endTime ↔ Output<String>

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

late, final

finalMeasurement ↔ Output<GoogleCloudAiplatformV1MeasurementResponse>

The final measurement containing the objective value.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

infeasibleReason ↔ Output<String>

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

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

late, final

measurements ↔ Output<List<Map<String, dynamic>>>

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

late, final

name ↔ Output<String>

Resource name of the Trial assigned by the service.

late, final

parameters ↔ Output<List<Map<String, dynamic>>>

The parameters of the Trial.

late, final

project ↔ Output<String>

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

startTime ↔ Output<String>

Time when the Trial was started.

late, final

state ↔ Output<String>

The detailed state of the Trial.

late, final

studyId ↔ Output<String>

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

webAccessUris ↔ Output<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.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited