CreatePredictor

nota

Esta operación crea un predictor heredado que no incluye todas las funcionalidades de predictor que proporciona Amazon Forecast. Para crear un predictor que sea compatible con todos los aspectos de Forecast, utilice CreateAutoPredictor.

Crea un predictor de Amazon Forecast.

En la solicitud, proporcione un grupo de conjuntos de datos y especifique un algoritmo o deja que Amazon Forecast elija por usted un algoritmo mediante AutoML. Si especifica un algoritmo, también puede anular los hiperparámetros específicos del algoritmo.

Amazon Forecast usa el algoritmo para entrenar un predictor con la versión más reciente de los conjuntos de datos del grupo de conjuntos de datos especificado. Luego podrá generar una previsión mediante la operación CreateForecast.

Para consultar las métricas de evaluación, utilice la operación GetAccuracyMetrics.

Puede especificar una configuración de características para rellenar y agregar los campos de datos del conjunto de datos TARGET_TIME_SERIES a fin de mejorar el entrenamiento del modelo. Para obtener más información, consulte FeaturizationConfig.

En el caso de los conjuntos de datos RELATED_TIME_SERIES, CreatePredictor verifica que la DataFrequency especificada al crear el conjunto de datos coincida con la ForecastFrequency. Los conjuntos de datos TARGET_TIME_SERIES no tienen esta restricción. Amazon Forecast también verifica el formato del delimitador y de la marca temporal. Para obtener más información, consulte Importación de conjuntos de datos.

De forma predeterminada, los predictores se entrenan y evalúan en los cuantiles de 0,1 (P10), 0,5 (P50) y 0,9 (P90). Puede elegir tipos de previsión personalizados para entrenar y evaluar su predictor estableciendo los ForecastTypes.

AutoML

Si quiere que Amazon Forecast evalúe cada algoritmo y elija el que minimice la objective function, establezca PerformAutoML en true. La objective function se define como la media de las pérdidas ponderadas entre los tipos de previsión. De forma predeterminada, se trata de las pérdidas por cuantiles p10, p50 y p90. Para obtener más información, consulte EvaluationResult.

Cuando la opción AutoML está habilitada, no se permiten las propiedades siguientes:

• AlgorithmArn

• HPOConfig

• PerformHPO

• TrainingParameters

Para obtener una lista de todos sus predictores, utilice la operación ListPredictors.

nota

Antes de poder usar el predictor para crear una previsión, el Status del previsor debe estar ACTIVE, lo que significa que el entrenamiento ha finalizado. Utilice la operación DescribePredictor para obtener el estado.

Sintaxis de la solicitud

{
   "AlgorithmArn": "string",
   "AutoMLOverrideStrategy": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "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"
         }
      ]
   },
   "OptimizationMetric": "string",
   "PerformAutoML": boolean,
   "PerformHPO": boolean,
   "PredictorName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrainingParameters": { 
      "string" : "string" 
   }
}

Parámetros de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

AlgorithmArn

El nombre de recurso de Amazon (ARN) del algoritmo que se va a utilizar para el entrenamiento del modelo. Obligatorio si PerformAutoML no está establecido en true.

Algoritmos admitidos

• arn:aws:forecast:::algorithm/ARIMA

• arn:aws:forecast:::algorithm/CNN-QR

• arn:aws:forecast:::algorithm/Deep_AR_Plus

• arn:aws:forecast:::algorithm/ETS

• arn:aws:forecast:::algorithm/NPTS

• arn:aws:forecast:::algorithm/Prophet

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

Obligatorio: no

AutoMLOverrideStrategy

nota

La estrategia de anulación del AutoML LatencyOptimized solo está disponible en la versión beta privada. Póngase en contacto con AWS Support o con el administrador de su cuenta para obtener más información sobre los privilegios de acceso.

Se utiliza para anular la estrategia de AutoML predeterminada, que consiste en optimizar la precisión del predictor. Para aplicar una estrategia de AutoML que minimice el tiempo de entrenamiento, utilice LatencyOptimized.

Este parámetro solo es válido para los predictores entrenados con AutoML.

Tipo: cadena

Valores válidos: LatencyOptimized | AccuracyOptimized

Obligatorio: no

EncryptionConfig

Una clave AWS Key Management Service (KMS) y la función AWS Identity and Access Management (IAM) que Amazon Forecast puede asumir para acceder a la clave.

Tipo: objeto EncryptionConfig

Obligatorio: no

EvaluationParameters

Se utiliza para anular los parámetros de evaluación predeterminados del algoritmo especificado. Amazon Forecast evalúa un predictor dividiendo un conjunto de datos en datos de entrenamiento y datos de prueba. Los parámetros de evaluación definen cómo realizar la división y el número de iteraciones.

Tipo: objeto EvaluationParameters

Obligatorio: no

FeaturizationConfig

La configuración de caracterización.

Tipo: objeto FeaturizationConfig

Obligatorio: sí

ForecastHorizon

Especifica el número de pasos de tiempo para los que se ha entrenado al modelo para la predicción. El horizonte de previsión también se denomina longitud de predicción.

Por ejemplo, si configura un conjunto de datos para la recopilación diaria de datos (utilizando el parámetro DataFrequency de la operación CreateDataset) y establece el horizonte de previsión en 10 días, el modelo devuelve predicciones para 10 días.

El horizonte máximo de previsión es 500 pasos de tiempo o 1/3 de la longitud del conjunto de datos TARGET_TIME_SERIES (el valor más pequeño).

Tipo: entero

Obligatorio: sí

ForecastTypes

Especifica los tipos de previsión usados para entrenar un predictor. Puede especificar hasta cinco tipos de previsión. Los tipos de previsión pueden ser cuantiles de 0,01 a 0,99, por incrementos de 0,01 o más. También puede especificar la previsión media con mean.

El valor predeterminado es ["0.10", "0.50", "0.9"].

Tipo: matriz de cadenas

Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 20 artículos.

Limitaciones de longitud: longitud mínima de 2. La longitud máxima es de 4 caracteres.

Patrón: (^0?\.\d\d?$|^mean$)

Obligatorio: no

HPOConfig

Proporciona valores de anulación de hiperparámetros para el algoritmo. Si no proporciona este parámetro, Amazon Forecast utilizará los valores predeterminados. Los algoritmos individuales especifican qué hiperparámetros admiten la optimización de hiperparámetros (HPO). Para obtener más información, consulte Algoritmos de Amazon Forecast.

Si ha incluido el objeto HPOConfig, debe establecer PerformHPO en true.

Tipo: objeto HyperParameterTuningJobConfig

Obligatorio: no

InputDataConfig

Describe el grupo de conjuntos de datos que contiene los datos que se utilizarán para entrenar el predictor.

Tipo: objeto InputDataConfig

Obligatorio: sí

OptimizationMetric

La métrica de precisión utilizada para optimizar el predictor. El valor predeterminado es AverageWeightedQuantileLoss.

Tipo: cadena

Valores válidos: WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

Obligatorio: no

PerformAutoML

Si se debe realizar AutoML. Cuando Amazon Forecast ejecuta AutoML, evalúa los algoritmos que proporciona y elige el mejor algoritmo y la mejor configuración para su conjunto de datos de entrenamiento.

El valor predeterminado es false. En este caso, es necesario especificar un algoritmo.

Establezca PerformAutoML en true para que Amazon Forecast ejecute AutoML. Esta es una buena opción si no está seguro de qué algoritmo es el adecuado para sus datos de entrenamiento. En este caso, PerformHPO debe ser false.

Tipo: Booleano

Obligatorio: no

PerformHPO

Si se debe realizar la optimización de hiperparámetros (HPO). HPO busca los valores de hiperparámetros óptimos para sus datos de entrenamiento. El proceso de realizar la HPO se conoce como ejecutar un trabajo de ajuste de hiperparámetros.

El valor predeterminado es false. En este caso, Amazon Forecast utiliza los valores de hiperparámetros predeterminados del algoritmo elegido.

Para anular los valores predeterminados, establezca PerformHPO en true y, si lo desea, suministre el objeto HyperParameterTuningJobConfig. El trabajo de ajuste especifica la métrica que se debe optimizar, los hiperparámetros que participan en el ajuste y el rango válido para cada hiperparámetro ajustable. En este caso, es necesario que especifique un algoritmo y PerformAutoML debe ser false.

Los siguientes algoritmos son compatibles con HPO:

• DeepAR+

• CNN-QR

Tipo: Booleano

Obligatorio: no

PredictorName

Un nombre para el predictor

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.

Patrón: ^[a-zA-Z][a-zA-Z0-9_]*

Obligatorio: sí

Tags

Los metadatos opcionales que se aplican al predictor para ayudarle a categorizarlos y organizarlos. Cada etiqueta está formada por una clave y un valor opcional, ambos definidos por el usuario.

Se aplican las siguientes restricciones básicas a las etiquetas:

• Número máximo de etiquetas por recurso: 50.

• Para cada recurso, cada clave de etiqueta debe ser única y solo puede tener un valor.

• Longitud máxima de la clave: 128 caracteres Unicode en UTF-8

• Longitud máxima del valor: 256 caracteres Unicode en UTF-8

• Si se utiliza su esquema de etiquetado en múltiples servicios y recursos, recuerde que otros servicios pueden tener otras restricciones sobre caracteres permitidos. Los caracteres permitidos generalmente son: letras, números y espacios representables en UTF-8, además de los siguientes caracteres: + - = . _ : / @.

• Las claves y los valores de las etiquetas distinguen entre mayúsculas y minúsculas.

• No utilice ningún prefijo para las teclas aws:AWS:, ni ninguna combinación de mayúsculas o minúsculas, ya que está reservado para su uso. AWS Las claves de etiquetas que tienen este prefijo no se pueden editar ni eliminar. Los valores pueden tener este prefijo. Si el valor de una etiqueta tiene aws como prefijo pero la clave no, Forecast la considera una etiqueta de usuario y se contabilizará en el límite de 50 etiquetas. Las etiquetas que tengan solo el prefijo de clave de aws no cuentan para el límite de etiquetas por recurso.

Tipo: matriz de objetos Tag

Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.

Obligatorio: no

TrainingParameters

Los hiperparámetros que se deben anular para el entrenamiento del modelo. Los hiperparámetros que puede anular se muestran en los algoritmos individuales. Para ver la lista de los algoritmos admitidos, consulte Algoritmos de Amazon Forecast.

Tipo: mapa de cadena a cadena

Entradas de mapa: número mínimo de 0 artículos. Número máximo de 100 artículos.

Limitaciones de longitud de clave: longitud máxima de 256.

Patrón de clave: ^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

Limitaciones de longitud de valor: longitud máxima de 256.

Patrón de valores: ^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$

Obligatorio: no

Sintaxis de la respuesta

{
   "PredictorArn": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

PredictorArn

El nombre de recurso de Amazon (ARN) del predictor.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

Errores

InvalidInputException

No podemos procesar la solicitud porque incluye un valor no válido o un valor que supera el rango válido.

Código de estado HTTP: 400

LimitExceededException

Se ha superado el límite en el número de recursos por cuenta.

Código de estado HTTP: 400

ResourceAlreadyExistsException

Ya existe un recurso con este nombre. Inténtelo de nuevo con un nombre diferente.

Código de estado HTTP: 400

ResourceInUseException

El recurso especificado está en uso.

Código de estado HTTP: 400

ResourceNotFoundException

No podemos encontrar un recurso con ese nombre de recurso de Amazon (ARN). Compruebe el ARN e inténtelo de nuevo.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente:

• Interfaz de la línea de comandos de AWS

• AWS SDK para .NET

• AWS SDK para C++

• AWS SDK para Go v2

• AWS SDK para Java V2

• AWS SDK para JavaScript V3

• AWS SDK para PHP V3

• AWS SDK para Python

• AWS SDK para Ruby V3