- Resource: Study
- StudyConfig
- MetricSpec
- GoalType
- ParameterSpec
- ParameterType
- DoubleValueSpec
- IntegerValueSpec
- CategoricalValueSpec
- DiscreteValueSpec
- ScaleType
- MatchingParentDiscreteValueSpec
- MatchingParentIntValueSpec
- MatchingParentCategoricalValueSpec
- Algorithm
- AutomatedStoppingConfig
- DecayCurveAutomatedStoppingConfig
- MedianAutomatedStoppingConfig
- State
- Methods
Resource: Study
A message representing a Study.
JSON representation | |
---|---|
{ "name": string, "studyConfig": { object ( |
Fields | |
---|---|
name |
Output only. The name of a study. |
studyConfig |
Required. Configuration of the study. |
state |
Output only. The detailed state of a study. |
createTime |
Output only. Time at which the study was created. |
inactiveReason |
Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. |
StudyConfig
Represents configuration of a study.
JSON representation | |
---|---|
{ "metrics": [ { object ( |
Fields | |
---|---|
metrics[] |
Metric specs for the study. |
parameters[] |
Required. The set of parameters to tune. |
algorithm |
The search algorithm specified for the study. |
automatedStoppingConfig |
Configuration for automated stopping of unpromising Trials. |
MetricSpec
Represents a metric to optimize.
JSON representation | |
---|---|
{
"goal": enum ( |
Fields | |
---|---|
goal |
Required. The optimization goal of the metric. |
metric |
Required. The name of the metric. |
GoalType
The available types of optimization goals.
Enums | |
---|---|
GOAL_TYPE_UNSPECIFIED |
Goal Type will default to maximize. |
MAXIMIZE |
Maximize the goal metric. |
MINIMIZE |
Minimize the goal metric. |
ParameterSpec
Represents a single parameter to optimize.
JSON representation | |
---|---|
{ "parameter": string, "type": enum ( |
Fields | ||
---|---|---|
parameter |
Required. The parameter name must be unique amongst all ParameterSpecs. |
|
type |
Required. The type of the parameter. |
|
scaleType |
How the parameter should be scaled. Leave unset for categorical parameters. |
|
childParameterSpecs[] |
A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in childParameterSpecs have the same name, they must have disjoint matching_parent_values. |
|
Union field
|
||
doubleValueSpec |
The value spec for a 'DOUBLE' parameter. |
|
integerValueSpec |
The value spec for an 'INTEGER' parameter. |
|
categoricalValueSpec |
The value spec for a 'CATEGORICAL' parameter. |
|
discreteValueSpec |
The value spec for a 'DISCRETE' parameter. |
|
Union field matching_parent_values . A set of Parameter values from the parent ParameterSpec's feasible space. One of these must be set if this ParameterSpec is a child of another ParameterSpec. matching_parent_values can be only one of the following: |
||
parentDiscreteValues |
|
|
parentIntValues |
|
|
parentCategoricalValues |
|
ParameterType
The type of the parameter.
Enums | |
---|---|
PARAMETER_TYPE_UNSPECIFIED |
You must specify a valid type. Using this unspecified type will result in an error. |
DOUBLE |
Type for real-valued parameters. |
INTEGER |
Type for integral parameters. |
CATEGORICAL |
The parameter is categorical, with a value chosen from the categories field. |
DISCRETE |
The parameter is real valued, with a fixed set of feasible points. If type==DISCRETE , feasible_points must be provided, and {minValue , maxValue } will be ignored. |
DoubleValueSpec
JSON representation | |
---|---|
{ "minValue": number, "maxValue": number } |
Fields | |
---|---|
minValue |
Must be specified if type is |
maxValue |
Must be specified if type is |
IntegerValueSpec
JSON representation | |
---|---|
{ "minValue": string, "maxValue": string } |
Fields | |
---|---|
minValue |
Must be specified if type is |
maxValue |
Must be specified if type is |
CategoricalValueSpec
JSON representation | |
---|---|
{ "values": [ string ] } |
Fields | |
---|---|
values[] |
Must be specified if type is |
DiscreteValueSpec
JSON representation | |
---|---|
{ "values": [ number ] } |
Fields | |
---|---|
values[] |
Must be specified if type is |
ScaleType
The type of scaling that should be applied to this parameter.
Enums | |
---|---|
SCALE_TYPE_UNSPECIFIED |
By default, no scaling is applied. |
UNIT_LINEAR_SCALE |
Scales the feasible space to (0, 1) linearly. |
UNIT_LOG_SCALE |
Scales the feasible space logarithmically to (0, 1). The entire feasible space must be strictly positive. |
UNIT_REVERSE_LOG_SCALE |
Scales the feasible space "reverse" logarithmically to (0, 1). The result is that values close to the top of the feasible space are spread out more than points near the bottom. The entire feasible space must be strictly positive. |
MatchingParentDiscreteValueSpec
Represents the spec to match discrete values from parent parameter.
JSON representation | |
---|---|
{ "values": [ number ] } |
Fields | |
---|---|
values[] |
Matches values of the parent parameter with type 'DISCRETE'. All values must exist in |
MatchingParentIntValueSpec
Represents the spec to match integer values from parent parameter.
JSON representation | |
---|---|
{ "values": [ string ] } |
Fields | |
---|---|
values[] |
Matches values of the parent parameter with type 'INTEGER'. All values must lie in |
MatchingParentCategoricalValueSpec
Represents the spec to match categorical values from parent parameter.
JSON representation | |
---|---|
{ "values": [ string ] } |
Fields | |
---|---|
values[] |
Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in |
Algorithm
The available search algorithms for the study.
Enums | |
---|---|
ALGORITHM_UNSPECIFIED |
The default algorithm used by the Cloud AI Platform Optimization service. |
GAUSSIAN_PROCESS_BANDIT |
Gaussian Process Bandit. |
GRID_SEARCH |
Simple grid search within the feasible space. To use grid search, all parameters must be INTEGER , CATEGORICAL , or DISCRETE . |
RANDOM_SEARCH |
Simple random search within the feasible space. |
AutomatedStoppingConfig
Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field
|
||
decayCurveStoppingConfig |
|
|
medianAutomatedStoppingConfig |
|
DecayCurveAutomatedStoppingConfig
JSON representation | |
---|---|
{ "useElapsedTime": boolean } |
Fields | |
---|---|
useElapsedTime |
If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis. |
MedianAutomatedStoppingConfig
The median automated stopping rule stops a pending trial if the trial's best objectiveValue is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement.
JSON representation | |
---|---|
{ "useElapsedTime": boolean } |
Fields | |
---|---|
useElapsedTime |
If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsedTime field of the current trial's latest measurement is used to compute the median objective value for each completed trial. |
State
Describes the study state.
Enums | |
---|---|
STATE_UNSPECIFIED |
The study state is unspecified. |
ACTIVE |
The study is active. |
INACTIVE |
The study is stopped due to an internal error. |
COMPLETED |
The study is done when the service exhausts the parameter search space or maxTrialCount is reached. |
Methods |
|
---|---|
|
Creates a study. |
|
Deletes a study. |
|
Gets a study. |
|
Lists all the studies in a region for an associated project. |