REST Resource: projects.locations.studies.trials

Resource: Trial

A message representing a trial.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "parameters": [
    {
      object (Parameter)
    }
  ],
  "finalMeasurement": {
    object (Measurement)
  },
  "measurements": [
    {
      object (Measurement)
    }
  ],
  "startTime": string,
  "endTime": string,
  "clientId": string,
  "trialInfeasible": boolean,
  "infeasibleReason": string
}
Fields
name

string

Output only. Name of the trial assigned by the service.
state

enum (State)

The detailed state of a trial.
parameters[]

object (Parameter)

The parameters of the trial.
finalMeasurement

object (Measurement)

The final measurement containing the objective value.
measurements[]

object (Measurement)

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

string (Timestamp format)

Output only. Time at which the trial was started.
endTime

string (Timestamp format)

Output only. Time at which the trial's status changed to COMPLETED.
clientId

string

Output only. The identifier of the client that originally requested this trial.
trialInfeasible

boolean

Output only. If true, the parameters in this trial are not attempted again.
infeasibleReason

string

Output only. A human readable string describing why the trial is infeasible. This should only be set if trialInfeasible is true.

State

Describes the trial state.

Enums
STATE_UNSPECIFIED The trial state is unspecified.
REQUESTED Indicates that a specific trial has been requested, but it has not yet been suggested by the service.
ACTIVE Indicates that the trial has been suggested.
COMPLETED Indicates that the trial is done, and either has a finalMeasurement set, or is marked as trialInfeasible.
STOPPING Indicates that the trial should stop according to the service.

Parameter

A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.

JSON representation 
{
  "parameter": string,

  // Union field value can be only one of the following:
  "floatValue": number,
  "intValue": string,
  "stringValue": string
  // End of list of possible types for union field value.
}
Fields
parameter

string

The name of the parameter.
Union field value. The value of the parameter. value can be only one of the following:
floatValue

number

Must be set if ParameterType is DOUBLE or DISCRETE.
intValue

string (int64 format)

Must be set if ParameterType is INTEGER
stringValue

string

Must be set if ParameterTypeis CATEGORICAL

Measurement

A message representing a measurement.

JSON representation 
{
  "elapsedTime": string,
  "stepCount": string,
  "metrics": [
    {
      object (Metric)
    }
  ]
}
Fields
elapsedTime

string (Duration format)

Output only. Time that the trial has been running at the point of this measurement.
stepCount

string (int64 format)

The number of steps a machine learning model has been trained for. Must be non-negative.
metrics[]

object (Metric)

Provides a list of metrics that act as inputs into the objective function.

Metric

A message representing a metric in the measurement.

JSON representation 
{
  "metric": string,
  "value": number
}
Fields
metric

string

Required. Metric name.
value

number

Required. The value for this metric.

Methods

addMeasurement

 Adds a measurement of the objective metrics to a trial.

checkEarlyStoppingState

 Checks whether a trial should stop or not.

complete

 Marks a trial as complete.

create

 Adds a user provided trial to a study.

delete

 Deletes a trial.

get

 Gets a trial.

list

 Lists the trials associated with a study.

stop

 Stops a trial.

suggest

 Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier.