REST-Ressource: projects.locations.studies

Ressource: Studie

Eine Nachricht, die eine Studie darstellt.

JSON-Darstellung

{
  "name": string,
  "studyConfig": {
    object (StudyConfig)
  },
  "state": enum (State),
  "createTime": string,
  "inactiveReason": string
}
Felder
name

string

Nur Ausgabe. Der Name einer Studie.

studyConfig

object (StudyConfig)

Erforderlich. Konfiguration der Studie.

state

enum (State)

Nur Ausgabe. Der detaillierte Status einer Studie.

createTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem die Studie erstellt wurde.

inactiveReason

string

Nur Ausgabe. Ein menschenlesbarer Grund, warum die Studie inaktiv ist. Dieser Wert sollte leer sein, wenn eine Studie AKTIV oder ABGESCHLOSSEN ist.

StudyConfig

Stellt die Konfiguration einer Studie dar.

JSON-Darstellung

{
  "metrics": [
    {
      object (MetricSpec)
    }
  ],
  "parameters": [
    {
      object (ParameterSpec)
    }
  ],
  "algorithm": enum (Algorithm),
  "automatedStoppingConfig": {
    object (AutomatedStoppingConfig)
  }
}
Felder
metrics[]

object (MetricSpec)

Messwertspezifikationen für die Studie.

parameters[]

object (ParameterSpec)

Erforderlich. Die zu optimierende Reihe von Parametern.

algorithm

enum (Algorithm)

Der für die Studie angegebene Suchalgorithmus.

automatedStoppingConfig

object (AutomatedStoppingConfig)

Konfiguration für das automatische Beenden von aussichtslosen Tests.

MetricSpec

Stellt einen zu optimierenden Messwert dar.

JSON-Darstellung

{
  "goal": enum (GoalType),
  "metric": string
}
Felder
goal

enum (GoalType)

Erforderlich. Das Optimierungsziel des Messwerts.

metric

string

Erforderlich. Der Name des Messwerts.

GoalType

Die verfügbaren Arten von Optimierungszielen.

Enums
GOAL_TYPE_UNSPECIFIED Der Zielvorhabentyp wird standardmäßig maximiert.
MAXIMIZE Maximieren Sie den Zielmesswert.
MINIMIZE Minimieren Sie den Zielmesswert.

ParameterSpec

Stellt einen einzelnen zu optimierenden Parameter dar.

JSON-Darstellung

{
  "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.
}
Felder
parameter

string

Erforderlich. Der Parametername muss unter allen ParameterSpecs eindeutig sein.

type

enum (ParameterType)

Erforderlich. Der Typ des Parameters.

scaleType

enum (ScaleType)

Skalierungsart des Parameters. Lassen Sie das Feld für kategoriale Parameter leer.

childParameterSpecs[]

object (ParameterSpec)

Ein untergeordneter Knoten ist aktiv, wenn der Wert des Parameters mit den matching_parent_values des untergeordneten Knotens übereinstimmt.

Wenn zwei Elemente in childParameterSpecs denselben Namen haben, müssen sie getrennte matching_parent_values haben.

Union-Feld parameter_value_spec.

Für parameter_value_spec ist nur einer der folgenden Werte zulässig:

doubleValueSpec

object (DoubleValueSpec)

Die Wertspezifikation für einen "DOUBLE"-Parameter.

integerValueSpec

object (IntegerValueSpec)

Die Wertspezifikation für einen "INTEGER"-Parameter.

categoricalValueSpec

object (CategoricalValueSpec)

Die Wertspezifikation für einen "CATEGORICAL"-Parameter.

discreteValueSpec

object (DiscreteValueSpec)

Die Wertspezifikation für einen "DISCRETE"-Parameter.

Union-Feld matching_parent_values. Eine Reihe von Parameterwerten aus dem zulässigen Bereich des übergeordneten ParameterSpec. Eine davon muss festgelegt werden, wenn diese ParameterSpec einer anderen ParameterSpec untergeordnet ist. Für matching_parent_values ist nur einer der folgenden Werte zulässig:
parentDiscreteValues

object (MatchingParentDiscreteValueSpec)

parentIntValues

object (MatchingParentIntValueSpec)

parentCategoricalValues

object (MatchingParentCategoricalValueSpec)

ParameterType

Der Typ des Parameters.

Enums
PARAMETER_TYPE_UNSPECIFIED Sie müssen einen gültigen Typ angeben. Die Verwendung dieses nicht angegebenen Typs führt zu einem Fehler.
DOUBLE Typ für reellwertige Parameter.
INTEGER Typ für integrale Parameter.
CATEGORICAL Der Parameter ist kategorial, wobei ein Wert aus dem Feld "Kategorien" ausgewählt wird.
DISCRETE Der Parameter ist reellwertig und enthält einen festen Satz zulässiger Punkte. Bei type==DISCRETE müssen feasible_points angegeben werden und {minValue, maxValue} wird ignoriert.

DoubleValueSpec

JSON-Darstellung

{
  "minValue": number,
  "maxValue": number
}
Felder
minValue

number

Muss angegeben werden, wenn der Typ DOUBLE ist. Mindestwert des Parameters.

maxValue

number

Muss angegeben werden, wenn der Typ DOUBLE ist. Maximalwert des Parameters.

IntegerValueSpec

JSON-Darstellung

{
  "minValue": string,
  "maxValue": string
}
Felder
minValue

string (int64 format)

Muss angegeben werden, wenn der Typ INTEGER ist. Mindestwert des Parameters.

maxValue

string (int64 format)

Muss angegeben werden, wenn der Typ INTEGER ist. Maximalwert des Parameters.

CategoricalValueSpec

JSON-Darstellung

{
  "values": [
    string
  ]
}
Felder
values[]

string

Muss angegeben werden, wenn der Typ CATEGORICAL ist. Die Liste der möglichen Kategorien.

DiscreteValueSpec

JSON-Darstellung

{
  "values": [
    number
  ]
}
Felder
values[]

number

Muss angegeben werden, wenn der Typ DISCRETE ist. Eine Liste mit zulässigen Punkten. Die Liste sollte streng aufsteigend sortiert sein. Dieser Parameter kann beispielsweise die Einstellungen 1.5, 2.5 und 4.0 haben. Diese Liste sollte nicht mehr als 1.000 Werte enthalten.

ScaleType

Die Art der Skalierung, die auf diesen Parameter angewendet werden soll.

Enums
SCALE_TYPE_UNSPECIFIED Standardmäßig wird keine Skalierung angewendet.
UNIT_LINEAR_SCALE Skaliert den zulässigen Bereich linear auf (0, 1).
UNIT_LOG_SCALE Skaliert den realisierbaren Bereich logarithmisch auf (0, 1). Der gesamte zulässige Platz muss strikt positiv sein.
UNIT_REVERSE_LOG_SCALE Skaliert den zulässigen Bereich "umgekehrt" logarithmisch auf (0, 1). Das hat zur Folge, dass Werte nahe dem oberen Rand des zulässigen Bereichs mehr verteilt werden als Punkte am unteren Rand. Der gesamte zulässige Platz muss strikt positiv sein.

MatchingParentDiscreteValueSpec

Stellt die Spezifikation dar, die mit den diskreten Werten des übergeordneten Parameters übereinstimmt.

JSON-Darstellung

{
  "values": [
    number
  ]
}
Felder
values[]

number

Gleicht Werte des übergeordneten Parameters mit dem Typ "DISCRETE" ab. Alle Werte müssen in discreteValueSpec des übergeordneten Parameters vorhanden sein.

MatchingParentIntValueSpec

Stellt die Spezifikation dar, um ganzzahlige Werte aus dem übergeordneten Parameter abzugleichen.

JSON-Darstellung

{
  "values": [
    string
  ]
}
Felder
values[]

string (int64 format)

Stimmt mit den Werten des übergeordneten Parameters vom Typ "INTEGER" überein. Alle Werte müssen in integerValueSpec des übergeordneten Parameters liegen.

MatchingParentCategoricalValueSpec

Stellt die Spezifikation dar, um kategoriale Werte aus dem übergeordneten Parameter abzugleichen.

JSON-Darstellung

{
  "values": [
    string
  ]
}
Felder
values[]

string

Stimmt mit den Werten des übergeordneten Parameters vom Typ "CATEGORICAL" überein. Alle Werte müssen in categoricalValueSpec des übergeordneten Parameters vorhanden sein.

Algorithmus

Die verfügbaren Suchalgorithmen für die Studie.

Enums
ALGORITHM_UNSPECIFIED Der Standardalgorithmus, der vom Cloud AI Platform Optimization-Dienst verwendet wird.
GAUSSIAN_PROCESS_BANDIT Gaußschen Prozessbandit.

AutomatedStoppingConfig

Konfiguration für das automatische vorzeitige Beenden von Tests. Wenn keine implementation_config festgelegt ist, wird kein automatisches vorzeitiges Beenden ausgeführt.

JSON-Darstellung

{

  // 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.
}
Felder

Union-Feld automated_stopping_config.

Für automated_stopping_config ist nur einer der folgenden Werte zulässig:

decayCurveStoppingConfig

object (DecayCurveAutomatedStoppingConfig)

medianAutomatedStoppingConfig

object (MedianAutomatedStoppingConfig)

DecayCurveAutomatedStoppingConfig

JSON-Darstellung

{
  "useElapsedTime": boolean
}
Felder
useElapsedTime

boolean

Wenn der Wert "true" ist, wird measurement.elapsed_time für die X-Achse jeder Testverlaufskurve verwendet. Andernfalls wird Measurement.steps als X-Achse verwendet.

MedianAutomatedStoppingConfig

Die Regel zum medianen automatischen Beenden stoppt einen ausstehenden Test, wenn der beste objectiveValue des Tests strikt unter der medianen "Leistung" aller abgeschlossenen Tests liegt, die bis zur letzten Messung des Tests gemeldet wurden. Derzeit bezieht sich "Leistung" auf den laufenden Durchschnitt der Zielwerte, die bei jeder Messung von der Studie gemeldet wurden.

JSON-Darstellung

{
  "useElapsedTime": boolean
}
Felder
useElapsedTime

boolean

Wenn der Wert "true" ist, wird die Regel zum medianen automatischen Beenden auf measurement.use_elapsed_time angewendet. Das Feld "elapsedTime" der aktuellen Messung der Tests wird zur Berechnung des medianen Zielwerts für jeden abgeschlossenen Test verwendet.

Status

Beschreibt den Studienstatus.

Enums
STATE_UNSPECIFIED Der Studienstatus ist nicht angegeben.
ACTIVE Die Studie ist aktiv.
INACTIVE Die Studie wurde aufgrund eines internen Fehlers beendet.
COMPLETED Die Studie ist abgeschlossen, wenn der Dienst den Parametersuchraum ausfüllt oder maxTrialCount erreicht wird.

Methoden

create

Erstellt eine Studie.

delete

Löscht eine Studie.

get

Ruft eine Studie ab.

list

Listet alle Studien in einer Region für ein verknüpftes Projekt auf.