REST リソース: projects.locations.studies

リソース: スタディ

スタディを表すメッセージ。

JSON 表現

{
  "name": string,
  "studyConfig": {
    object (StudyConfig)
  },
  "state": enum (State),
  "createTime": string,
  "inactiveReason": string
}
フィールド
name

string

出力のみ。スタディの名前。

studyConfig

object (StudyConfig)

必須。スタディの構成。

state

enum (State)

出力のみ。スタディの詳細な状態。

createTime

string (Timestamp format)

出力のみ。スタディが作成された時刻。

inactiveReason

string

出力のみ。スタディが無効であることについての人が読める形式での理由。スタディが ACTIVE または COMPLETED の場合は空白にします。

StudyConfig

スタディの構成を表します。

JSON 表現

{
  "metrics": [
    {
      object (MetricSpec)
    }
  ],
  "parameters": [
    {
      object (ParameterSpec)
    }
  ],
  "algorithm": enum (Algorithm),
  "automatedStoppingConfig": {
    object (AutomatedStoppingConfig)
  }
}
フィールド
metrics[]

object (MetricSpec)

スタディの指標仕様。

parameters[]

object (ParameterSpec)

必須。調整するパラメータのセット。

algorithm

enum (Algorithm)

スタディに指定された検索アルゴリズム。

automatedStoppingConfig

object (AutomatedStoppingConfig)

成功の見込みがないと思われるトライアルの自動停止の構成。

MetricSpec

最適化する指標を表します。

JSON 表現

{
  "goal": enum (GoalType),
  "metric": string
}
フィールド
goal

enum (GoalType)

必須。指標の最適化目標。

metric

string

必須。指標の名前。

GoalType

使用可能な最適化目標のタイプ。

列挙型
GOAL_TYPE_UNSPECIFIED 目標タイプはデフォルトで最大化になります。
MAXIMIZE 目標指標を最大化します。
MINIMIZE 目標指標を最小化します。

ParameterSpec

最適化する単一のパラメータを表します。

JSON 表現

{
  "parameter": string,
  "type": enum (ParameterType),
  "scaleType": enum (ScaleType),
  "childParameterSpecs": [
    {
      object (ParameterSpec)
    }
  ],

  // Union field parameter_value_spec can be only one of the following:
  "doubleValueSpec": {
    object (DoubleValueSpec)
  },
  "integerValueSpec": {
    object (IntegerValueSpec)
  },
  "categoricalValueSpec": {
    object (CategoricalValueSpec)
  },
  "discreteValueSpec": {
    object (DiscreteValueSpec)
  }
  // End of list of possible types for union field parameter_value_spec.

  // Union field matching_parent_values can be only one of the following:
  "parentDiscreteValues": {
    object (MatchingParentDiscreteValueSpec)
  },
  "parentIntValues": {
    object (MatchingParentIntValueSpec)
  },
  "parentCategoricalValues": {
    object (MatchingParentCategoricalValueSpec)
  }
  // End of list of possible types for union field matching_parent_values.
}
フィールド
parameter

string

必須。パラメータ名は、すべての ParameterSpec の中で一意である必要があります。

type

enum (ParameterType)

必須。パラメータのタイプ。

scaleType

enum (ScaleType)

パラメータのスケーリング方法。カテゴリ パラメータには設定しないでください。

childParameterSpecs[]

object (ParameterSpec)

子ノードは、パラメータの値が子ノードの matching_parent_values と一致する場合に有効になります。

childParameterSpecs の 2 つのアイテムに同じ名前を付ける場合は、重ならない matching_parent_values を指定する必要があります。

共用体フィールド parameter_value_spec

parameter_value_spec は次のいずれかになります。

doubleValueSpec

object (DoubleValueSpec)

「DOUBLE」パラメータの値仕様。

integerValueSpec

object (IntegerValueSpec)

「INTEGER」パラメータの値仕様。

categoricalValueSpec

object (CategoricalValueSpec)

「CATEGORICAL」パラメータの値仕様。

discreteValueSpec

object (DiscreteValueSpec)

「DISCRETE」パラメータの値仕様。

共用体フィールド matching_parent_values。親 ParameterSpec の実行可能領域から取得したパラメータ値のセット。この ParameterSpec が別の ParameterSpec の子である場合は、これらのいずれかを設定する必要があります。matching_parent_values は次のいずれかになります。
parentDiscreteValues

object (MatchingParentDiscreteValueSpec)

parentIntValues

object (MatchingParentIntValueSpec)

parentCategoricalValues

object (MatchingParentCategoricalValueSpec)

ParameterType

パラメータのタイプ。

列挙型
PARAMETER_TYPE_UNSPECIFIED 有効なタイプを指定する必要があります。未指定のタイプを使用すると、エラーが発生します。
DOUBLE 実数パラメータのタイプ。
INTEGER 整数パラメータのタイプ。
CATEGORICAL パラメータはカテゴリで、categories フィールドで選択した値が入っています。
DISCRETE パラメータは実数で、実行可能点の定値が入っています。type==DISCRETE の場合、feasible_points を指定する必要があり、{minValue, maxValue} は無視されます。

DoubleValueSpec

JSON 表現

{
  "minValue": number,
  "maxValue": number
}
フィールド
minValue

number

タイプが DOUBLE の場合に指定する必要があります。パラメータの最小値。

maxValue

number

タイプが DOUBLE の場合に指定する必要があります。パラメータの最大値。

IntegerValueSpec

JSON 表現

{
  "minValue": string,
  "maxValue": string
}
フィールド
minValue

string (int64 format)

タイプが INTEGER の場合に指定する必要があります。パラメータの最小値。

maxValue

string (int64 format)

タイプが INTEGER の場合に指定する必要があります。パラメータの最大値。

CategoricalValueSpec

JSON 表現

{
  "values": [
    string
  ]
}
フィールド
values[]

string

タイプが CATEGORICAL の場合に指定する必要があります。可能性のあるカテゴリのリスト。

DiscreteValueSpec

JSON 表現

{
  "values": [
    number
  ]
}
フィールド
values[]

number

タイプが DISCRETE の場合に指定する必要があります。実行可能点のリスト。リストは厳密に昇順でなければなりません。たとえば、このパラメータには 1.5、2.5、4.0 という設定が考えられます。このリストには 1,000 個を超える値を含めることはできません。

ScaleType

このパラメータに適用するスケーリングのタイプ。

列挙型
SCALE_TYPE_UNSPECIFIED デフォルトでは、スケーリングは適用されません。
UNIT_LINEAR_SCALE 実行可能領域を(0, 1)まで直線的にスケーリングします。
UNIT_LOG_SCALE 実行可能領域を(0, 1)まで対数的にスケーリングします。実行可能領域全体は真に正である必要があります。
UNIT_REVERSE_LOG_SCALE 実行可能領域を(0, 1)まで「逆」対数的にスケーリングします。結果は、実行可能領域の上部に近い値の方が、下部に近い点より多く分布します。実行可能領域全体は真に正である必要があります。

MatchingParentDiscreteValueSpec

親パラメータの個別の値を一致させる仕様を表します。

JSON 表現

{
  "values": [
    number
  ]
}
フィールド
values[]

number

親パラメータの値をタイプ「DISCRETE」と一致させます。すべての値は親パラメータの discreteValueSpec に存在する必要があります。

MatchingParentIntValueSpec

親パラメータの整数値を一致させる仕様を表します。

JSON 表現

{
  "values": [
    string
  ]
}
フィールド
values[]

string (int64 format)

親パラメータの値をタイプ「INTEGER」と一致させます。すべての値は、親パラメータの integerValueSpec に含まれている必要があります。

MatchingParentCategoricalValueSpec

親パラメータのカテゴリ値を一致させる仕様を表します。

JSON 表現

{
  "values": [
    string
  ]
}
フィールド
values[]

string

親パラメータの値をタイプ「CATEGORICAL」と一致させます。すべての値は親パラメータの categoricalValueSpec に存在する必要があります。

Algorithm

スタディで使用できる検索アルゴリズム。

列挙型
ALGORITHM_UNSPECIFIED Cloud AI Platform 最適化サービスで使用されるデフォルトのアルゴリズム。
GAUSSIAN_PROCESS_BANDIT ガウス過程バンディット。

AutomatedStoppingConfig

トライアルの自動早期停止の構成。implementation_config が設定されていない場合、自動早期停止は実行されません。

JSON 表現

{

  // Union field automated_stopping_config can be only one of the following:
  "decayCurveStoppingConfig": {
    object (DecayCurveAutomatedStoppingConfig)
  },
  "medianAutomatedStoppingConfig": {
    object (MedianAutomatedStoppingConfig)
  }
  // End of list of possible types for union field automated_stopping_config.
}
フィールド

共用体フィールド automated_stopping_config

automated_stopping_config は次のいずれかになります。

decayCurveStoppingConfig

object (DecayCurveAutomatedStoppingConfig)

medianAutomatedStoppingConfig

object (MedianAutomatedStoppingConfig)

DecayCurveAutomatedStoppingConfig

JSON 表現

{
  "useElapsedTime": boolean
}
フィールド
useElapsedTime

boolean

true の場合、measurement.elapsed_time が各トライアルの遅延曲線の X 軸として使用されます。それ以外の場合は、Measurement.steps が X 軸として使用されます。

MedianAutomatedStoppingConfig

トライアルの最善の objectiveValue が、トライアルの最終の測定までに報告されたすべての完了済みトライアルの中央値「パフォーマンス」を厳密に下回っている場合、中央値の自動停止ルールは保留になります。現在、「パフォーマンス」とは、トライアルの各測定で報告された目標値の移動平均を指します。

JSON 表現

{
  "useElapsedTime": boolean
}
フィールド
useElapsedTime

boolean

true の場合、中央値の自動停止ルールは measurement.use_elapsed_time に適用されます。つまり、現在のトライアルの最新測定値の elapsedTime フィールドが、完了した各トライアルの目標値の中央値を計算するために使用されます。

State

スタディの状態を表します。

列挙型
STATE_UNSPECIFIED スタディの状態が指定されていません。
ACTIVE スタディは有効です。
INACTIVE 内部エラーのためスタディが中止されました。
COMPLETED スタディは、サービスがパラメータ検索空間を使い切るか、maxTrialCount に達したときに行われます。

メソッド

create

スタディを作成します。

delete

スタディを削除します。

get

調査を取得します。

list

関連付けられたプロジェクトのリージョン内にあるすべてのスタディの一覧を表示します。