trials

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

Overview

Name	trials
Type	Resource
Id	google.ml.trials

Fields

Name	Datatype	Description
name	string	Output only. Name of the trial assigned by the service.
clientId	string	Output only. The identifier of the client that originally requested this trial.
endTime	string	Output only. Time at which the trial's status changed to COMPLETED.
finalMeasurement	object	A message representing a measurement.
infeasibleReason	string	Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
measurements	array	A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
parameters	array	The parameters of the trial.
startTime	string	Output only. Time at which the trial was started.
state	string	The detailed state of a trial.
trialInfeasible	boolean	Output only. If true, the parameters in this trial are not attempted again.

Methods

Name	Accessible by	Required Params	Description
projects_locations_studies_trials_get	SELECT	locationsId, projectsId, studiesId, trialsId	Gets a trial.
projects_locations_studies_trials_list	SELECT	locationsId, projectsId, studiesId	Lists the trials associated with a study.
projects_locations_studies_trials_create	INSERT	locationsId, projectsId, studiesId	Adds a user provided trial to a study.
projects_locations_studies_trials_delete	DELETE	locationsId, projectsId, studiesId, trialsId	Deletes a trial.
projects_locations_studies_trials_check_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.
projects_locations_studies_trials_complete	EXEC	locationsId, projectsId, studiesId, trialsId	Marks a trial as complete.
projects_locations_studies_trials_stop	EXEC	locationsId, projectsId, studiesId, trialsId	Stops a trial.
projects_locations_studies_trials_suggest	EXEC	locationsId, projectsId, studiesId	Adds one or more trials to a study, with parameter values suggested by AI Platform 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
name,
clientId,
endTime,
finalMeasurement,
infeasibleReason,
measurements,
parameters,
startTime,
state,
trialInfeasible
FROM google.ml.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.ml.trials (
locationsId,
projectsId,
studiesId,
state,
parameters,
finalMeasurement,
measurements
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ studiesId }}',
'{{ state }}',
'{{ parameters }}',
'{{ finalMeasurement }}',
'{{ measurements }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: state
      value: string
    - name: parameters
      value:
        - - name: parameter
            value: string
          - name: floatValue
            value: number
          - name: intValue
            value: string
          - name: stringValue
            value: string
    - name: finalMeasurement
      value:
        - name: elapsedTime
          value: string
        - name: stepCount
          value: string
        - name: metrics
          value:
            - - name: metric
                value: string
              - name: value
                value: number
    - name: measurements
      value:
        - - name: elapsedTime
            value: string
          - name: stepCount
            value: string
          - name: metrics
            value:
              - - name: metric
                  value: string
                - name: value
                  value: number
    - name: startTime
      value: string
    - name: endTime
      value: string
    - name: clientId
      value: string
    - name: trialInfeasible
      value: boolean
    - name: infeasibleReason
      value: string

DELETE example

Deletes the specified trials resource.

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