ForecastService / Client / describe_predictor

describe_predictor

ForecastService.Client.describe_predictor(**kwargs)

Note

This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor.

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

• DatasetImportJobArns - The dataset import jobs used to import training data.

• AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.

• CreationTime

• LastModificationTime

• Status

• Message - If an error occurred, information about the error.

See also: AWS API Documentation

Request Syntax

response = client.describe_predictor(
    PredictorArn='string'
)

Parameters:

PredictorArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the predictor that you want information about.

Return type:

dict

Returns:

Response Syntax

{
    'PredictorArn': 'string',
    'PredictorName': 'string',
    'AlgorithmArn': 'string',
    'AutoMLAlgorithmArns': [
        'string',
    ],
    'ForecastHorizon': 123,
    'ForecastTypes': [
        'string',
    ],
    'PerformAutoML': True|False,
    'AutoMLOverrideStrategy': 'LatencyOptimized'|'AccuracyOptimized',
    'PerformHPO': True|False,
    'TrainingParameters': {
        'string': 'string'
    },
    'EvaluationParameters': {
        'NumberOfBacktestWindows': 123,
        'BackTestWindowOffset': 123
    },
    'HPOConfig': {
        'ParameterRanges': {
            'CategoricalParameterRanges': [
                {
                    'Name': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'ContinuousParameterRanges': [
                {
                    'Name': 'string',
                    'MaxValue': 123.0,
                    'MinValue': 123.0,
                    'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic'
                },
            ],
            'IntegerParameterRanges': [
                {
                    'Name': 'string',
                    'MaxValue': 123,
                    'MinValue': 123,
                    'ScalingType': 'Auto'|'Linear'|'Logarithmic'|'ReverseLogarithmic'
                },
            ]
        }
    },
    'InputDataConfig': {
        'DatasetGroupArn': 'string',
        'SupplementaryFeatures': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ]
    },
    'FeaturizationConfig': {
        'ForecastFrequency': 'string',
        'ForecastDimensions': [
            'string',
        ],
        'Featurizations': [
            {
                'AttributeName': 'string',
                'FeaturizationPipeline': [
                    {
                        'FeaturizationMethodName': 'filling',
                        'FeaturizationMethodParameters': {
                            'string': 'string'
                        }
                    },
                ]
            },
        ]
    },
    'EncryptionConfig': {
        'RoleArn': 'string',
        'KMSKeyArn': 'string'
    },
    'PredictorExecutionDetails': {
        'PredictorExecutions': [
            {
                'AlgorithmArn': 'string',
                'TestWindows': [
                    {
                        'TestWindowStart': datetime(2015, 1, 1),
                        'TestWindowEnd': datetime(2015, 1, 1),
                        'Status': 'string',
                        'Message': 'string'
                    },
                ]
            },
        ]
    },
    'EstimatedTimeRemainingInMinutes': 123,
    'IsAutoPredictor': True|False,
    'DatasetImportJobArns': [
        'string',
    ],
    'Status': 'string',
    'Message': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModificationTime': datetime(2015, 1, 1),
    'OptimizationMetric': 'WAPE'|'RMSE'|'AverageWeightedQuantileLoss'|'MASE'|'MAPE'
}

Response Structure

• (dict) –

  • PredictorArn (string) –

    The ARN of the predictor.

  • PredictorName (string) –

    The name of the predictor.

  • AlgorithmArn (string) –

    The Amazon Resource Name (ARN) of the algorithm used for model training.

  • AutoMLAlgorithmArns (list) –

    When PerformAutoML is specified, the ARN of the chosen algorithm.

    • (string) –

  • ForecastHorizon (integer) –

    The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

  • ForecastTypes (list) –

    The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]

    • (string) –

  • PerformAutoML (boolean) –

    Whether the predictor is set to perform AutoML.

  • AutoMLOverrideStrategy (string) –

    Note

    The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

    The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

    This parameter is only valid for predictors trained using AutoML.

  • PerformHPO (boolean) –

    Whether the predictor is set to perform hyperparameter optimization (HPO).

  • TrainingParameters (dict) –

    The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

    • (string) –

      • (string) –

  • EvaluationParameters (dict) –

    Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

    • NumberOfBacktestWindows (integer) –

      The number of times to split the input data. The default is 1. Valid values are 1 through 5.

    • BackTestWindowOffset (integer) –

      The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.

      ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

  • HPOConfig (dict) –

    The hyperparameter override values for the algorithm.

    • ParameterRanges (dict) –

      Specifies the ranges of valid values for the hyperparameters.

      • CategoricalParameterRanges (list) –

        Specifies the tunable range for each categorical hyperparameter.

        • (dict) –

          Specifies a categorical hyperparameter and it’s range of tunable values. This object is part of the ParameterRanges object.

          • Name (string) –

            The name of the categorical hyperparameter to tune.

          • Values (list) –

            A list of the tunable categories for the hyperparameter.

            • (string) –

      • ContinuousParameterRanges (list) –

        Specifies the tunable range for each continuous hyperparameter.

        • (dict) –

          Specifies a continuous hyperparameter and it’s range of tunable values. This object is part of the ParameterRanges object.

          • Name (string) –

            The name of the hyperparameter to tune.

          • MaxValue (float) –

            The maximum tunable value of the hyperparameter.

          • MinValue (float) –

            The minimum tunable value of the hyperparameter.

          • ScalingType (string) –

            The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

            Auto

            Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

            Linear

            Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

            Logarithmic

            Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

            Logarithmic scaling works only for ranges that have values greater than 0.

            ReverseLogarithmic

            hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

            Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

            For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

      • IntegerParameterRanges (list) –

        Specifies the tunable range for each integer hyperparameter.

        • (dict) –

          Specifies an integer hyperparameter and it’s range of tunable values. This object is part of the ParameterRanges object.

          • Name (string) –

            The name of the hyperparameter to tune.

          • MaxValue (integer) –

            The maximum tunable value of the hyperparameter.

          • MinValue (integer) –

            The minimum tunable value of the hyperparameter.

          • ScalingType (string) –

            The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

            Auto

            Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

            Linear

            Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

            Logarithmic

            Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

            Logarithmic scaling works only for ranges that have values greater than 0.

            ReverseLogarithmic

            Not supported for IntegerParameterRange.

            Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

            For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

  • InputDataConfig (dict) –

    Describes the dataset group that contains the data to use to train the predictor.

    • DatasetGroupArn (string) –

      The Amazon Resource Name (ARN) of the dataset group.

    • SupplementaryFeatures (list) –

      An array of supplementary features. The only supported feature is a holiday calendar.

      • (dict) –

        Note

        This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.

        Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.

        Weather Index

        The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.

        Holidays

        Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.

        • Name (string) –

          The name of the feature. Valid values: "holiday" and "weather".

        • Value (string) –

          Weather Index

          To enable the Weather Index, set the value to "true"

          Holidays

          To enable Holidays, specify a country with one of the following two-letter country codes:

          • ”AL” - ALBANIA

          • ”AR” - ARGENTINA

          • ”AT” - AUSTRIA

          • ”AU” - AUSTRALIA

          • ”BA” - BOSNIA HERZEGOVINA

          • ”BE” - BELGIUM

          • ”BG” - BULGARIA

          • ”BO” - BOLIVIA

          • ”BR” - BRAZIL

          • ”BY” - BELARUS

          • ”CA” - CANADA

          • ”CL” - CHILE

          • ”CO” - COLOMBIA

          • ”CR” - COSTA RICA

          • ”HR” - CROATIA

          • ”CZ” - CZECH REPUBLIC

          • ”DK” - DENMARK

          • ”EC” - ECUADOR

          • ”EE” - ESTONIA

          • ”ET” - ETHIOPIA

          • ”FI” - FINLAND

          • ”FR” - FRANCE

          • ”DE” - GERMANY

          • ”GR” - GREECE

          • ”HU” - HUNGARY

          • ”IS” - ICELAND

          • ”IN” - INDIA

          • ”IE” - IRELAND

          • ”IT” - ITALY

          • ”JP” - JAPAN

          • ”KZ” - KAZAKHSTAN

          • ”KR” - KOREA

          • ”LV” - LATVIA

          • ”LI” - LIECHTENSTEIN

          • ”LT” - LITHUANIA

          • ”LU” - LUXEMBOURG

          • ”MK” - MACEDONIA

          • ”MT” - MALTA

          • ”MX” - MEXICO

          • ”MD” - MOLDOVA

          • ”ME” - MONTENEGRO

          • ”NL” - NETHERLANDS

          • ”NZ” - NEW ZEALAND

          • ”NI” - NICARAGUA

          • ”NG” - NIGERIA

          • ”NO” - NORWAY

          • ”PA” - PANAMA

          • ”PY” - PARAGUAY

          • ”PE” - PERU

          • ”PL” - POLAND

          • ”PT” - PORTUGAL

          • ”RO” - ROMANIA

          • ”RU” - RUSSIA

          • ”RS” - SERBIA

          • ”SK” - SLOVAKIA

          • ”SI” - SLOVENIA

          • ”ZA” - SOUTH AFRICA

          • ”ES” - SPAIN

          • ”SE” - SWEDEN

          • ”CH” - SWITZERLAND

          • ”UA” - UKRAINE

          • ”AE” - UNITED ARAB EMIRATES

          • ”US” - UNITED STATES

          • ”UK” - UNITED KINGDOM

          • ”UY” - URUGUAY

          • ”VE” - VENEZUELA

  • FeaturizationConfig (dict) –

    The featurization configuration.

    • ForecastFrequency (string) –

      The frequency of predictions in a forecast.

      Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, “1D” indicates every day and “15min” indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:

      • Minute - 1-59

      • Hour - 1-23

      • Day - 1-6

      • Week - 1-4

      • Month - 1-11

      • Year - 1

      Thus, if you want every other week forecasts, specify “2W”. Or, if you want quarterly forecasts, you specify “3M”.

      The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

      When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the TARGET_TIME_SERIES dataset frequency.

    • ForecastDimensions (list) –

      An array of dimension (field) names that specify how to group the generated forecast.

      For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id field. If you want the sales forecast for each item by store, you would specify store_id as the dimension.

      All forecast dimensions specified in the TARGET_TIME_SERIES dataset don’t need to be specified in the CreatePredictor request. All forecast dimensions specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor request.

      • (string) –

    • Featurizations (list) –

      An array of featurization (transformation) information for the fields of a dataset.

      • (dict) –

        Note

        This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.

        Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.

        For example:

        {

        "AttributeName": "demand",

        FeaturizationPipeline [ {

        "FeaturizationMethodName": "filling",

        "FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}

        } ]

        }

        • AttributeName (string) –

          The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target is target_value. For more information, see howitworks-missing-values.

        • FeaturizationPipeline (list) –

          An array of one FeaturizationMethod object that specifies the feature transformation method.

          • (dict) –

            Provides information about the method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object.

            The following is an example of how you specify a FeaturizationMethod object.

            {

            "FeaturizationMethodName": "filling",

            "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}

            }

            • FeaturizationMethodName (string) –

              The name of the method. The “filling” method is the only supported method.

            • FeaturizationMethodParameters (dict) –

              The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.

              The following list shows the parameters and their valid values for the “filling” featurization method for a Target Time Series dataset. Bold signifies the default value.

              • aggregation: sum, avg, first, min, max

              • frontfill: none

              • middlefill: zero, nan (not a number), value, median, mean, min, max

              • backfill: zero, nan, value, median, mean, min, max

              The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

              • middlefill: zero, value, median, mean, min, max

              • backfill: zero, value, median, mean, min, max

              • futurefill: zero, value, median, mean, min, max

              To set a filling method to a specific value, set the fill parameter to value and define the value in a corresponding _value parameter. For example, to set backfilling to a value of 2, include the following: "backfill": "value" and "backfill_value":"2".

              • (string) –

                • (string) –

  • EncryptionConfig (dict) –

    An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

    • RoleArn (string) –

      The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.

      Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn’t in your account, you get an InvalidInputException error.

    • KMSKeyArn (string) –

      The Amazon Resource Name (ARN) of the KMS key.

  • PredictorExecutionDetails (dict) –

    Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

    • PredictorExecutions (list) –

      An array of the backtests performed to evaluate the accuracy of the predictor against a particular algorithm. The NumberOfBacktestWindows from the object determines the number of windows in the array.

      • (dict) –

        The algorithm used to perform a backtest and the status of those tests.

        • AlgorithmArn (string) –

          The ARN of the algorithm used to test the predictor.

        • TestWindows (list) –

          An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows from the object determines the number of windows in the array.

          • (dict) –

            The status, start time, and end time of a backtest, as well as a failure reason if applicable.

            • TestWindowStart (datetime) –

              The time at which the test began.

            • TestWindowEnd (datetime) –

              The time at which the test ended.

            • Status (string) –

              The status of the test. Possible status values are:

              • ACTIVE

              • CREATE_IN_PROGRESS

              • CREATE_FAILED

            • Message (string) –

              If the test failed, the reason why it failed.

  • EstimatedTimeRemainingInMinutes (integer) –

    The estimated time remaining in minutes for the predictor training job to complete.

  • IsAutoPredictor (boolean) –

    Whether the predictor was created with CreateAutoPredictor.

  • DatasetImportJobArns (list) –

    An array of the ARNs of the dataset import jobs used to import training data for the predictor.

    • (string) –

  • Status (string) –

    The status of the predictor. States include:

    • ACTIVE

    • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

    • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

    • CREATE_STOPPING, CREATE_STOPPED

    Note

    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

  • Message (string) –

    If an error occurred, an informational message about the error.

  • CreationTime (datetime) –

    When the model training task was created.

  • LastModificationTime (datetime) –

    The last time the resource was modified. The timestamp depends on the status of the job:

    • CREATE_PENDING - The CreationTime.

    • CREATE_IN_PROGRESS - The current timestamp.

    • CREATE_STOPPING - The current timestamp.

    • CREATE_STOPPED - When the job stopped.

    • ACTIVE or CREATE_FAILED - When the job finished or failed.

  • OptimizationMetric (string) –

    The accuracy metric used to optimize the predictor.

Exceptions

• ForecastService.Client.exceptions.InvalidInputException

• ForecastService.Client.exceptions.ResourceNotFoundException