DescribePredictor - Amazon Forecast
AnforderungssyntaxAnfrageparameterAntwortsyntaxAntwortelementeErrorsWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribePredictor

Anmerkung

Dieser Vorgang gilt nur für Legacy-Prädiktoren, die mit CreatePredictor erstellt wurden. Wenn Sie keinen Legacy-Prädiktor verwenden, verwenden SieDescribeAutoPredictoraus.

Beschreibt einen Predictor, der mit derCreatePredictorverwenden.

Neben der Auflistung der in derCreatePredictorrequest, dieser Vorgang listet die folgenden Eigenschaften auf:

  • DatasetImportJobArns- Die Dataset-Importjobs, die zum Importieren von Trainingsdaten verwendet werden.

  • AutoMLAlgorithmArns- Wenn AutoML ausgeführt wird, wurden die Algorithmen ausgewertet.

  • CreationTime

  • LastModificationTime

  • Status

  • Message- Wenn ein Fehler aufgetreten ist, Informationen über den Fehler.

Anforderungssyntax

{
   "PredictorArn": "string"
}

Anfrageparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

PredictorArn

Der Amazon-Ressourcenname (ARN) des Prädiktors, über den Sie Informationen benötigen.

Type: Zeichenfolge

Einschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

: Erforderlich Ja

Antwortsyntax

{
   "AlgorithmArn": "string",
   "AutoMLAlgorithmArns": [ "string" ],
   "AutoMLOverrideStrategy": "string",
   "CreationTime": number,
   "DatasetImportJobArns": [ "string" ],
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EstimatedTimeRemainingInMinutes": number,
   "EvaluationParameters": { 
      "BackTestWindowOffset": number,
      "NumberOfBacktestWindows": number
   },
   "FeaturizationConfig": { 
      "Featurizations": [ 
         { 
            "AttributeName": "string",
            "FeaturizationPipeline": [ 
               { 
                  "FeaturizationMethodName": "string",
                  "FeaturizationMethodParameters": { 
                     "string" : "string" 
                  }
               }
            ]
         }
      ],
      "ForecastDimensions": [ "string" ],
      "ForecastFrequency": "string"
   },
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "HPOConfig": { 
      "ParameterRanges": { 
         "CategoricalParameterRanges": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "ContinuousParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ],
         "IntegerParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ]
      }
   },
   "InputDataConfig": { 
      "DatasetGroupArn": "string",
      "SupplementaryFeatures": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ]
   },
   "IsAutoPredictor": boolean,
   "LastModificationTime": number,
   "Message": "string",
   "OptimizationMetric": "string",
   "PerformAutoML": boolean,
   "PerformHPO": boolean,
   "PredictorArn": "string",
   "PredictorExecutionDetails": { 
      "PredictorExecutions": [ 
         { 
            "AlgorithmArn": "string",
            "TestWindows": [ 
               { 
                  "Message": "string",
                  "Status": "string",
                  "TestWindowEnd": number,
                  "TestWindowStart": number
               }
            ]
         }
      ]
   },
   "PredictorName": "string",
   "Status": "string",
   "TrainingParameters": { 
      "string" : "string" 
   }
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

AlgorithmArn

Der Amazon-Ressourcenname (ARN) der für das Modelltraining verwendeten Algorithmus.

Type: Zeichenfolge

Einschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

AutoMLAlgorithmArns

WannPerformAutoMLangegeben ist, ist der ARN des gewählten Algorithmus angegeben.

Type: Zeichenfolgen-Array

Einschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

AutoMLOverrideStrategy
Anmerkung

DieLatencyOptimizedDie AutoML-Override-Strategie ist nur in privater Beta verfügbar. Wenden Sie sich an den AWS Support oder Ihren Account Manager, um mehr über Zugriffsberechtigungen zu erfahren.

Die AutoML-Strategie, die zum Trainieren des Prädiktors verwendet wurde. Es sei dennLatencyOptimizedangegeben ist, optimiert die AutoML-Strategie die Prädiktorgenauigkeit.

Dieser Parameter gilt nur für Prädiktoren, die mit AutoML trainiert wurden.

Type: Zeichenfolge

Zulässige Werte: LatencyOptimized | AccuracyOptimized

CreationTime

Als die Modelltrainingsaufgabe erstellt wurde.

Type: Zeitstempel

DatasetImportJobArns

Ein Array der ARNs der Dataset-Importjobs, die zum Importieren von Trainingsdaten für den Prädiktor verwendet werden.

Type: Zeichenfolgen-Array

Einschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

EncryptionConfig

Ein AWS Key Management Service (KMS) -Schlüssel und die AWS Identity and Access Management (IAM) -Rolle, die Amazon Forecast annehmen kann, um auf den Schlüssel zuzugreifen.

Typ: EncryptionConfig Objekt

EstimatedTimeRemainingInMinutes

Die geschätzte verbleibende Zeit in Minuten, bis die Predictor-Trainingsaufgabe abgeschlossen ist.

Type: Long

EvaluationParameters

Wird verwendet, um die Standardauswertungsparameter des angegebenen Algorithmus zu überschreiben. Amazon Forecast Forector wertet einen Predictor aus, indem ein Dataset in Schulungsdaten und Testdaten aufgeteilt wird. Die Auswertungsparameter definieren, wie die Teilung und die Anzahl der Iterationen durchgeführt werden.

Typ: EvaluationParameters Objekt

FeaturizationConfig

Die Featurisierungskonfiguration.

Typ: FeaturizationConfig Objekt

ForecastHorizon

Die Anzahl der Zeitschritte der Prognose. Der Prognosehorizont wird auch als Prognoselänge bezeichnet.

Type: Ganzzahl

ForecastTypes

Die während des Prädiktortrainings verwendeten Prognosetypen. Der Standardwert ist["0.1","0.5","0.9"]

Type: Zeichenfolgen-Array

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.

Einschränkungen: Mindestlänge 2. Maximale Länge beträgt 4 Zeichen.

Pattern: (^0?\.\d\d?$|^mean$)

HPOConfig

Der Hyperparameter überschreibt Werte für den Algorithmus.

Typ: HyperParameterTuningJobConfig Objekt

InputDataConfig

Beschreibt die Datensatzgruppe, die die Daten enthält, die zum Trainieren des Prädiktors verwendet werden sollen.

Typ: InputDataConfig Objekt

IsAutoPredictor

Ob der Prädiktor mit erstellt wurdeCreateAutoPredictoraus.

Type: Boolesch

LastModificationTime

Die Uhrzeit, wann die Ressource zuletzt geändert wurde. Der Zeitstempel hängt vom Status des Auftrags ab:

  • CREATE_PENDING- DieCreationTimeaus.

  • CREATE_IN_PROGRESS- Aktueller Zeitstempel

  • CREATE_STOPPING- Aktueller Zeitstempel

  • CREATE_STOPPED- Als der Job aufhörte.

  • ACTIVEoderCREATE_FAILED- Wenn der Job beendet ist oder fehlgeschlagen ist.

Type: Zeitstempel

Message

Wenn ein Fehler aufgetreten ist, ist dies ein Informationsmeldungstext über den Fehler aufgetreten.

Type: Zeichenfolge

OptimizationMetric

Die zur Optimierung des Prädiktors verwendete Genauigkeitsmetrik.

Type: Zeichenfolge

Zulässige Werte: WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PerformAutoML

Ob der Prädiktor für die Ausführung von AutoML eingestellt ist.

Type: Boolesch

PerformHPO

Ob der Prädiktor für die Durchführung einer Hyperparameter-Optimierung (HPO) eingestellt ist.

Type: Boolesch

PredictorArn

Der ARN des Predictors.

Type: Zeichenfolge

Einschränkungen: Mindestlänge 1. Maximale Länge beträgt 63 Zeichen.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

PredictorExecutionDetails

Details zum Status und den Ergebnissen der Backtests, die zur Bewertung der Genauigkeit des Prädiktors durchgeführt wurden. Sie geben die Anzahl der Backtests an, die ausgeführt werden sollen, wenn SieCreatePredictorverwenden.

Typ: PredictorExecutionDetails Objekt

PredictorName

Der Name des Predictors.

Type: Zeichenfolge

Einschränkungen: Mindestlänge 1. Maximale Länge beträgt 63 Zeichen.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

Status

Der Status des Predictors. Zu den Zuständen gehören:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

Anmerkung

DieStatusdes Prädiktors muss seinACTIVEbevor Sie den Predictor verwenden können, um eine Prognose zu erstellen.

Type: Zeichenfolge

Einschränkungen: Maximale Länge beträgt 256 Zeichen.

TrainingParameters

Die Standard-Trainingsparameter oder -überschreibungen, die während des Modelltrainings ausgewählt wurden. Wenn Sie AutoML ausführen oder HPO mit CNN-QR oder DeePar+ wählen, werden die optimierten Werte für die ausgewählten Hyperparameter zurückgegeben. Weitere Informationen finden Sie unter Amazon-Prognosealgorithmen.

Type: Zeichenfolge-zu-Zeichenfolge-Zuweisung

Map-Einträge: Minimale Anzahl der Elemente: 0. Die maximale Anzahl beträgt 100 Elemente.

Einschränkungen: Maximale Länge beträgt 256 Zeichen.

Schlüssel-Muster: ^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

Beschränkungen für Wertlänge: Maximale Länge beträgt 256 Zeichen.

Wert-Muster:^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$

Errors

InvalidInputException

Wir können die Anfrage nicht bearbeiten, da sie einen ungültigen Wert oder einen Wert enthält, der den gültigen Bereich überschreitet.

HTTP-Statuscode: 400

ResourceNotFoundException

Wir können keine -Ressource mit diesem Amazon Resource Name (ARN) finden. Überprüfen Sie die ARN und versuchen Sie es erneut.

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: