Skip to main content

trials

Overview

Nametrials
TypeResource
Idgoogle.ml.trials

Fields

NameDatatypeDescription
namestringOutput only. Name of the trial assigned by the service.
clientIdstringOutput only. The identifier of the client that originally requested this trial.
endTimestringOutput only. Time at which the trial's status changed to COMPLETED.
finalMeasurementobjectA message representing a measurement.
infeasibleReasonstringOutput only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
measurementsarrayA list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
parametersarrayThe parameters of the trial.
startTimestringOutput only. Time at which the trial was started.
statestringThe detailed state of a trial.
trialInfeasiblebooleanOutput only. If true, the parameters in this trial are not attempted again.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_studies_trials_getSELECTlocationsId, projectsId, studiesId, trialsIdGets a trial.
projects_locations_studies_trials_listSELECTlocationsId, projectsId, studiesIdLists the trials associated with a study.
projects_locations_studies_trials_createINSERTlocationsId, projectsId, studiesIdAdds a user provided trial to a study.
projects_locations_studies_trials_deleteDELETElocationsId, projectsId, studiesId, trialsIdDeletes a trial.
projects_locations_studies_trials_check_early_stopping_stateEXEClocationsId, projectsId, studiesId, trialsIdChecks 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_completeEXEClocationsId, projectsId, studiesId, trialsIdMarks a trial as complete.
projects_locations_studies_trials_stopEXEClocationsId, projectsId, studiesId, trialsIdStops a trial.
projects_locations_studies_trials_suggestEXEClocationsId, projectsId, studiesIdAdds 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.