trials

Creates, updates, deletes, gets or lists a trials resource.

Overview

Name	trials
Type	Resource
Id	google.aiplatform.trials

Fields

Name	Datatype	Description
id	string	Output only. The identifier of the Trial assigned by the service.
name	string	Output only. Resource name of the Trial assigned by the service.
clientId	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.
customJob	string	Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
endTime	string	Output only. Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.
finalMeasurement	object	A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.
infeasibleReason	string	Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.
measurements	array	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.
parameters	array	Output only. The parameters of the Trial.
startTime	string	Output only. Time when the Trial was started.
state	string	Output only. The detailed state of the Trial.
webAccessUris	object	Output only. 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.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, studiesId, trialsId	Gets a Trial.
list	SELECT	locationsId, projectsId, studiesId	Lists the Trials associated with a Study.
create	INSERT	locationsId, projectsId, studiesId	Adds a user provided Trial to a Study.
delete	DELETE	locationsId, projectsId, studiesId, trialsId	Deletes a Trial.
check_trial_early_stopping_state	EXEC	locationsId, projectsId, studiesId, trialsId	Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
complete	EXEC	locationsId, projectsId, studiesId, trialsId	Marks a Trial as complete.
stop	EXEC	locationsId, projectsId, studiesId, trialsId	Stops a Trial.
suggest	EXEC	locationsId, projectsId, studiesId	Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.

SELECT examples

Lists the Trials associated with a Study.

SELECT
id,
name,
clientId,
customJob,
endTime,
finalMeasurement,
infeasibleReason,
measurements,
parameters,
startTime,
state,
webAccessUris
FROM google.aiplatform.trials
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND studiesId = '{{ studiesId }}';

INSERT example

Use the following StackQL query and manifest file to create a new trials resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.trials (
locationsId,
projectsId,
studiesId
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ studiesId }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: clientId
      value: string
    - name: name
      value: string
    - name: customJob
      value: string
    - name: finalMeasurement
      value:
        - name: stepCount
          value: string
        - name: elapsedDuration
          value: string
        - name: metrics
          value:
            - - name: value
                value: number
              - name: metricId
                value: string
    - name: startTime
      value: string
    - name: measurements
      value:
        - - name: stepCount
            value: string
          - name: elapsedDuration
            value: string
          - name: metrics
            value:
              - - name: value
                  value: number
                - name: metricId
                  value: string
    - name: state
      value: string
    - name: endTime
      value: string
    - name: webAccessUris
      value: object
    - name: parameters
      value:
        - - name: value
            value: any
          - name: parameterId
            value: string
    - name: infeasibleReason
      value: string

DELETE example

Deletes the specified trials resource.

/*+ delete */
DELETE FROM google.aiplatform.trials
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND studiesId = '{{ studiesId }}'
AND trialsId = '{{ trialsId }}';