@aws-sdk/client-forecast 3.28.0 → 3.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/Forecast.ts +10 -12
- package/commands/GetAccuracyMetricsCommand.ts +10 -12
- package/dist/cjs/Forecast.js.map +1 -1
- package/dist/cjs/commands/GetAccuracyMetricsCommand.js +10 -12
- package/dist/cjs/commands/GetAccuracyMetricsCommand.js.map +1 -1
- package/dist/cjs/models/models_0.js +11 -3
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/package.json +31 -31
- package/dist/cjs/protocols/Aws_json1_1.js +66 -59
- package/dist/cjs/protocols/Aws_json1_1.js.map +1 -1
- package/dist/es/Forecast.js.map +1 -1
- package/dist/es/commands/GetAccuracyMetricsCommand.js +10 -12
- package/dist/es/commands/GetAccuracyMetricsCommand.js.map +1 -1
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +8 -0
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/package.json +31 -31
- package/dist/es/protocols/Aws_json1_1.js +68 -62
- package/dist/es/protocols/Aws_json1_1.js.map +1 -1
- package/dist/types/Forecast.d.ts +10 -12
- package/dist/types/commands/GetAccuracyMetricsCommand.d.ts +10 -12
- package/dist/types/models/models_0.d.ts +69 -35
- package/dist/types/ts3.4/Forecast.d.ts +10 -12
- package/dist/types/ts3.4/commands/GetAccuracyMetricsCommand.d.ts +10 -12
- package/dist/types/ts3.4/models/models_0.d.ts +69 -35
- package/models/models_0.ts +76 -35
- package/package.json +31 -31
- package/protocols/Aws_json1_1.ts +72 -61
package/dist/types/Forecast.d.ts
CHANGED
|
@@ -591,21 +591,19 @@ export declare class Forecast extends ForecastClient {
|
|
|
591
591
|
* to decide whether to use the predictor to generate a forecast. For more information, see
|
|
592
592
|
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Predictor
|
|
593
593
|
* Metrics</a>.</p>
|
|
594
|
-
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
595
|
-
* (<code>NumberOfBacktestWindows</code>) is specified using the
|
|
596
|
-
*
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
* contribute, specify <code>nan</code>.
|
|
603
|
-
* For more information, see <a>FeaturizationMethod</a>.</p>
|
|
594
|
+
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
595
|
+
* of backtest windows (<code>NumberOfBacktestWindows</code>) is specified using the <a>EvaluationParameters</a> object, which is optionally included in the
|
|
596
|
+
* <code>CreatePredictor</code> request. If <code>NumberOfBacktestWindows</code> isn't
|
|
597
|
+
* specified, the number defaults to one.</p>
|
|
598
|
+
* <p>The parameters of the <code>filling</code> method determine which items contribute to the
|
|
599
|
+
* metrics. If you want all items to contribute, specify <code>zero</code>. If you want only
|
|
600
|
+
* those items that have complete data in the range being evaluated to contribute, specify
|
|
601
|
+
* <code>nan</code>. For more information, see <a>FeaturizationMethod</a>.</p>
|
|
604
602
|
*
|
|
605
603
|
* <note>
|
|
606
604
|
* <p>Before you can get accuracy metrics, the <code>Status</code> of the predictor must be
|
|
607
|
-
*
|
|
608
|
-
*
|
|
605
|
+
* <code>ACTIVE</code>, signifying that training has completed. To get the status, use the
|
|
606
|
+
* <a>DescribePredictor</a> operation.</p>
|
|
609
607
|
* </note>
|
|
610
608
|
*/
|
|
611
609
|
getAccuracyMetrics(args: GetAccuracyMetricsCommandInput, options?: __HttpHandlerOptions): Promise<GetAccuracyMetricsCommandOutput>;
|
|
@@ -11,21 +11,19 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
|
|
|
11
11
|
* to decide whether to use the predictor to generate a forecast. For more information, see
|
|
12
12
|
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Predictor
|
|
13
13
|
* Metrics</a>.</p>
|
|
14
|
-
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
15
|
-
* (<code>NumberOfBacktestWindows</code>) is specified using the
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* contribute, specify <code>nan</code>.
|
|
23
|
-
* For more information, see <a>FeaturizationMethod</a>.</p>
|
|
14
|
+
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
15
|
+
* of backtest windows (<code>NumberOfBacktestWindows</code>) is specified using the <a>EvaluationParameters</a> object, which is optionally included in the
|
|
16
|
+
* <code>CreatePredictor</code> request. If <code>NumberOfBacktestWindows</code> isn't
|
|
17
|
+
* specified, the number defaults to one.</p>
|
|
18
|
+
* <p>The parameters of the <code>filling</code> method determine which items contribute to the
|
|
19
|
+
* metrics. If you want all items to contribute, specify <code>zero</code>. If you want only
|
|
20
|
+
* those items that have complete data in the range being evaluated to contribute, specify
|
|
21
|
+
* <code>nan</code>. For more information, see <a>FeaturizationMethod</a>.</p>
|
|
24
22
|
*
|
|
25
23
|
* <note>
|
|
26
24
|
* <p>Before you can get accuracy metrics, the <code>Status</code> of the predictor must be
|
|
27
|
-
*
|
|
28
|
-
*
|
|
25
|
+
* <code>ACTIVE</code>, signifying that training has completed. To get the status, use the
|
|
26
|
+
* <a>DescribePredictor</a> operation.</p>
|
|
29
27
|
* </note>
|
|
30
28
|
* @example
|
|
31
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -1321,6 +1321,13 @@ export declare namespace InputDataConfig {
|
|
|
1321
1321
|
*/
|
|
1322
1322
|
const filterSensitiveLog: (obj: InputDataConfig) => any;
|
|
1323
1323
|
}
|
|
1324
|
+
export declare enum OptimizationMetric {
|
|
1325
|
+
AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
|
|
1326
|
+
MAPE = "MAPE",
|
|
1327
|
+
MASE = "MASE",
|
|
1328
|
+
RMSE = "RMSE",
|
|
1329
|
+
WAPE = "WAPE"
|
|
1330
|
+
}
|
|
1324
1331
|
export interface CreatePredictorRequest {
|
|
1325
1332
|
/**
|
|
1326
1333
|
* <p>A name for the predictor.</p>
|
|
@@ -1395,7 +1402,12 @@ export interface CreatePredictorRequest {
|
|
|
1395
1402
|
*/
|
|
1396
1403
|
PerformAutoML?: boolean;
|
|
1397
1404
|
/**
|
|
1398
|
-
* <
|
|
1405
|
+
* <note>
|
|
1406
|
+
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
1407
|
+
* Contact AWS Support or your account manager to learn more about access privileges.
|
|
1408
|
+
* </p>
|
|
1409
|
+
* </note>
|
|
1410
|
+
* <p>Used to overide the default AutoML strategy, which is to optimize predictor accuracy.
|
|
1399
1411
|
* To apply an AutoML strategy that minimizes training time, use
|
|
1400
1412
|
* <code>LatencyOptimized</code>.</p>
|
|
1401
1413
|
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
@@ -1486,6 +1498,10 @@ export interface CreatePredictorRequest {
|
|
|
1486
1498
|
* </ul>
|
|
1487
1499
|
*/
|
|
1488
1500
|
Tags?: Tag[];
|
|
1501
|
+
/**
|
|
1502
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
1503
|
+
*/
|
|
1504
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
1489
1505
|
}
|
|
1490
1506
|
export declare namespace CreatePredictorRequest {
|
|
1491
1507
|
/**
|
|
@@ -2409,7 +2425,12 @@ export interface DescribePredictorResponse {
|
|
|
2409
2425
|
*/
|
|
2410
2426
|
PerformAutoML?: boolean;
|
|
2411
2427
|
/**
|
|
2412
|
-
* <
|
|
2428
|
+
* <note>
|
|
2429
|
+
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
2430
|
+
* Contact AWS Support or your account manager to learn more about access privileges.
|
|
2431
|
+
* </p>
|
|
2432
|
+
* </note>
|
|
2433
|
+
* <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
|
|
2413
2434
|
* is specified, the AutoML strategy optimizes predictor accuracy.</p>
|
|
2414
2435
|
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
2415
2436
|
*/
|
|
@@ -2534,6 +2555,10 @@ export interface DescribePredictorResponse {
|
|
|
2534
2555
|
* </ul>
|
|
2535
2556
|
*/
|
|
2536
2557
|
LastModificationTime?: Date;
|
|
2558
|
+
/**
|
|
2559
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
2560
|
+
*/
|
|
2561
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
2537
2562
|
}
|
|
2538
2563
|
export declare namespace DescribePredictorResponse {
|
|
2539
2564
|
/**
|
|
@@ -2658,30 +2683,30 @@ export declare enum EvaluationType {
|
|
|
2658
2683
|
SUMMARY = "SUMMARY"
|
|
2659
2684
|
}
|
|
2660
2685
|
/**
|
|
2661
|
-
* <p>
|
|
2662
|
-
*
|
|
2663
|
-
* part of the <a>Metrics</a> object.
|
|
2664
|
-
* </p>
|
|
2686
|
+
* <p> Provides detailed error metrics to evaluate the performance of a predictor. This object
|
|
2687
|
+
* is part of the <a>Metrics</a> object. </p>
|
|
2665
2688
|
*/
|
|
2666
2689
|
export interface ErrorMetric {
|
|
2667
2690
|
/**
|
|
2668
|
-
* <p>
|
|
2669
|
-
* The Forecast type used to compute WAPE and RMSE.
|
|
2670
|
-
* </p>
|
|
2691
|
+
* <p> The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. </p>
|
|
2671
2692
|
*/
|
|
2672
2693
|
ForecastType?: string;
|
|
2673
2694
|
/**
|
|
2674
|
-
* <p>
|
|
2675
|
-
* The weighted absolute percentage error (WAPE).
|
|
2676
|
-
* </p>
|
|
2695
|
+
* <p> The weighted absolute percentage error (WAPE). </p>
|
|
2677
2696
|
*/
|
|
2678
2697
|
WAPE?: number;
|
|
2679
2698
|
/**
|
|
2680
|
-
* <p>
|
|
2681
|
-
* The root-mean-square error (RMSE).
|
|
2682
|
-
* </p>
|
|
2699
|
+
* <p> The root-mean-square error (RMSE). </p>
|
|
2683
2700
|
*/
|
|
2684
2701
|
RMSE?: number;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The Mean Absolute Scaled Error (MASE)</p>
|
|
2704
|
+
*/
|
|
2705
|
+
MASE?: number;
|
|
2706
|
+
/**
|
|
2707
|
+
* <p>The Mean Absolute Percentage Error (MAPE)</p>
|
|
2708
|
+
*/
|
|
2709
|
+
MAPE?: number;
|
|
2685
2710
|
}
|
|
2686
2711
|
export declare namespace ErrorMetric {
|
|
2687
2712
|
/**
|
|
@@ -2690,14 +2715,13 @@ export declare namespace ErrorMetric {
|
|
|
2690
2715
|
const filterSensitiveLog: (obj: ErrorMetric) => any;
|
|
2691
2716
|
}
|
|
2692
2717
|
/**
|
|
2693
|
-
* <p>The weighted loss value for a quantile. This object is part of the
|
|
2694
|
-
* <a>Metrics</a> object.</p>
|
|
2718
|
+
* <p>The weighted loss value for a quantile. This object is part of the <a>Metrics</a> object.</p>
|
|
2695
2719
|
*/
|
|
2696
2720
|
export interface WeightedQuantileLoss {
|
|
2697
2721
|
/**
|
|
2698
2722
|
* <p>The quantile. Quantiles divide a probability distribution into regions of equal
|
|
2699
|
-
* probability. For example, if the distribution was divided into 5 regions of equal
|
|
2700
|
-
*
|
|
2723
|
+
* probability. For example, if the distribution was divided into 5 regions of equal probability,
|
|
2724
|
+
* the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>
|
|
2701
2725
|
*/
|
|
2702
2726
|
Quantile?: number;
|
|
2703
2727
|
/**
|
|
@@ -2713,8 +2737,8 @@ export declare namespace WeightedQuantileLoss {
|
|
|
2713
2737
|
const filterSensitiveLog: (obj: WeightedQuantileLoss) => any;
|
|
2714
2738
|
}
|
|
2715
2739
|
/**
|
|
2716
|
-
* <p>Provides metrics that are used to evaluate the performance of a predictor. This object
|
|
2717
|
-
*
|
|
2740
|
+
* <p>Provides metrics that are used to evaluate the performance of a predictor. This object is
|
|
2741
|
+
* part of the <a>WindowSummary</a> object.</p>
|
|
2718
2742
|
*/
|
|
2719
2743
|
export interface Metrics {
|
|
2720
2744
|
/**
|
|
@@ -2729,12 +2753,15 @@ export interface Metrics {
|
|
|
2729
2753
|
*/
|
|
2730
2754
|
WeightedQuantileLosses?: WeightedQuantileLoss[];
|
|
2731
2755
|
/**
|
|
2732
|
-
* <p>
|
|
2733
|
-
*
|
|
2734
|
-
* average percentage error (WAPE).
|
|
2735
|
-
* </p>
|
|
2756
|
+
* <p> Provides detailed error metrics for each forecast type. Metrics include root-mean
|
|
2757
|
+
* square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE),
|
|
2758
|
+
* and weighted average percentage error (WAPE). </p>
|
|
2736
2759
|
*/
|
|
2737
2760
|
ErrorMetrics?: ErrorMetric[];
|
|
2761
|
+
/**
|
|
2762
|
+
* <p>The average value of all weighted quantile losses.</p>
|
|
2763
|
+
*/
|
|
2764
|
+
AverageWeightedQuantileLoss?: number;
|
|
2738
2765
|
}
|
|
2739
2766
|
export declare namespace Metrics {
|
|
2740
2767
|
/**
|
|
@@ -2743,11 +2770,10 @@ export declare namespace Metrics {
|
|
|
2743
2770
|
const filterSensitiveLog: (obj: Metrics) => any;
|
|
2744
2771
|
}
|
|
2745
2772
|
/**
|
|
2746
|
-
* <p>The metrics for a time range within the evaluation portion of a dataset. This object
|
|
2747
|
-
*
|
|
2748
|
-
* <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are
|
|
2749
|
-
*
|
|
2750
|
-
* <a>EvaluationParameters</a> object.</p>
|
|
2773
|
+
* <p>The metrics for a time range within the evaluation portion of a dataset. This object is
|
|
2774
|
+
* part of the <a>EvaluationResult</a> object.</p>
|
|
2775
|
+
* <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are determined
|
|
2776
|
+
* by the <code>BackTestWindowOffset</code> parameter of the <a>EvaluationParameters</a> object.</p>
|
|
2751
2777
|
*/
|
|
2752
2778
|
export interface WindowSummary {
|
|
2753
2779
|
/**
|
|
@@ -2788,8 +2814,7 @@ export declare namespace WindowSummary {
|
|
|
2788
2814
|
const filterSensitiveLog: (obj: WindowSummary) => any;
|
|
2789
2815
|
}
|
|
2790
2816
|
/**
|
|
2791
|
-
* <p>The results of evaluating an algorithm. Returned as part of the
|
|
2792
|
-
* <a>GetAccuracyMetrics</a> response.</p>
|
|
2817
|
+
* <p>The results of evaluating an algorithm. Returned as part of the <a>GetAccuracyMetrics</a> response.</p>
|
|
2793
2818
|
*/
|
|
2794
2819
|
export interface EvaluationResult {
|
|
2795
2820
|
/**
|
|
@@ -2798,8 +2823,8 @@ export interface EvaluationResult {
|
|
|
2798
2823
|
AlgorithmArn?: string;
|
|
2799
2824
|
/**
|
|
2800
2825
|
* <p>The array of test windows used for evaluating the algorithm. The
|
|
2801
|
-
*
|
|
2802
|
-
*
|
|
2826
|
+
* <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a> object
|
|
2827
|
+
* determines the number of windows in the array.</p>
|
|
2803
2828
|
*/
|
|
2804
2829
|
TestWindows?: WindowSummary[];
|
|
2805
2830
|
}
|
|
@@ -2815,11 +2840,20 @@ export interface GetAccuracyMetricsResponse {
|
|
|
2815
2840
|
*/
|
|
2816
2841
|
PredictorEvaluationResults?: EvaluationResult[];
|
|
2817
2842
|
/**
|
|
2818
|
-
* <
|
|
2843
|
+
* <note>
|
|
2844
|
+
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
2845
|
+
* Contact AWS Support or your account manager to learn more about access privileges.
|
|
2846
|
+
* </p>
|
|
2847
|
+
* </note>
|
|
2848
|
+
* <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
|
|
2819
2849
|
* is specified, the AutoML strategy optimizes predictor accuracy.</p>
|
|
2820
2850
|
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
2821
2851
|
*/
|
|
2822
2852
|
AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
2855
|
+
*/
|
|
2856
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
2823
2857
|
}
|
|
2824
2858
|
export declare namespace GetAccuracyMetricsResponse {
|
|
2825
2859
|
/**
|
|
@@ -591,21 +591,19 @@ export declare class Forecast extends ForecastClient {
|
|
|
591
591
|
* to decide whether to use the predictor to generate a forecast. For more information, see
|
|
592
592
|
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Predictor
|
|
593
593
|
* Metrics</a>.</p>
|
|
594
|
-
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
595
|
-
* (<code>NumberOfBacktestWindows</code>) is specified using the
|
|
596
|
-
*
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
* contribute, specify <code>nan</code>.
|
|
603
|
-
* For more information, see <a>FeaturizationMethod</a>.</p>
|
|
594
|
+
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
595
|
+
* of backtest windows (<code>NumberOfBacktestWindows</code>) is specified using the <a>EvaluationParameters</a> object, which is optionally included in the
|
|
596
|
+
* <code>CreatePredictor</code> request. If <code>NumberOfBacktestWindows</code> isn't
|
|
597
|
+
* specified, the number defaults to one.</p>
|
|
598
|
+
* <p>The parameters of the <code>filling</code> method determine which items contribute to the
|
|
599
|
+
* metrics. If you want all items to contribute, specify <code>zero</code>. If you want only
|
|
600
|
+
* those items that have complete data in the range being evaluated to contribute, specify
|
|
601
|
+
* <code>nan</code>. For more information, see <a>FeaturizationMethod</a>.</p>
|
|
604
602
|
*
|
|
605
603
|
* <note>
|
|
606
604
|
* <p>Before you can get accuracy metrics, the <code>Status</code> of the predictor must be
|
|
607
|
-
*
|
|
608
|
-
*
|
|
605
|
+
* <code>ACTIVE</code>, signifying that training has completed. To get the status, use the
|
|
606
|
+
* <a>DescribePredictor</a> operation.</p>
|
|
609
607
|
* </note>
|
|
610
608
|
*/
|
|
611
609
|
getAccuracyMetrics(args: GetAccuracyMetricsCommandInput, options?: __HttpHandlerOptions): Promise<GetAccuracyMetricsCommandOutput>;
|
|
@@ -11,21 +11,19 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
|
|
|
11
11
|
* to decide whether to use the predictor to generate a forecast. For more information, see
|
|
12
12
|
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Predictor
|
|
13
13
|
* Metrics</a>.</p>
|
|
14
|
-
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
15
|
-
* (<code>NumberOfBacktestWindows</code>) is specified using the
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* contribute, specify <code>nan</code>.
|
|
23
|
-
* For more information, see <a>FeaturizationMethod</a>.</p>
|
|
14
|
+
* <p>This operation generates metrics for each backtest window that was evaluated. The number
|
|
15
|
+
* of backtest windows (<code>NumberOfBacktestWindows</code>) is specified using the <a>EvaluationParameters</a> object, which is optionally included in the
|
|
16
|
+
* <code>CreatePredictor</code> request. If <code>NumberOfBacktestWindows</code> isn't
|
|
17
|
+
* specified, the number defaults to one.</p>
|
|
18
|
+
* <p>The parameters of the <code>filling</code> method determine which items contribute to the
|
|
19
|
+
* metrics. If you want all items to contribute, specify <code>zero</code>. If you want only
|
|
20
|
+
* those items that have complete data in the range being evaluated to contribute, specify
|
|
21
|
+
* <code>nan</code>. For more information, see <a>FeaturizationMethod</a>.</p>
|
|
24
22
|
*
|
|
25
23
|
* <note>
|
|
26
24
|
* <p>Before you can get accuracy metrics, the <code>Status</code> of the predictor must be
|
|
27
|
-
*
|
|
28
|
-
*
|
|
25
|
+
* <code>ACTIVE</code>, signifying that training has completed. To get the status, use the
|
|
26
|
+
* <a>DescribePredictor</a> operation.</p>
|
|
29
27
|
* </note>
|
|
30
28
|
* @example
|
|
31
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -1321,6 +1321,13 @@ export declare namespace InputDataConfig {
|
|
|
1321
1321
|
*/
|
|
1322
1322
|
const filterSensitiveLog: (obj: InputDataConfig) => any;
|
|
1323
1323
|
}
|
|
1324
|
+
export declare enum OptimizationMetric {
|
|
1325
|
+
AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
|
|
1326
|
+
MAPE = "MAPE",
|
|
1327
|
+
MASE = "MASE",
|
|
1328
|
+
RMSE = "RMSE",
|
|
1329
|
+
WAPE = "WAPE"
|
|
1330
|
+
}
|
|
1324
1331
|
export interface CreatePredictorRequest {
|
|
1325
1332
|
/**
|
|
1326
1333
|
* <p>A name for the predictor.</p>
|
|
@@ -1395,7 +1402,12 @@ export interface CreatePredictorRequest {
|
|
|
1395
1402
|
*/
|
|
1396
1403
|
PerformAutoML?: boolean;
|
|
1397
1404
|
/**
|
|
1398
|
-
* <
|
|
1405
|
+
* <note>
|
|
1406
|
+
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
1407
|
+
* Contact AWS Support or your account manager to learn more about access privileges.
|
|
1408
|
+
* </p>
|
|
1409
|
+
* </note>
|
|
1410
|
+
* <p>Used to overide the default AutoML strategy, which is to optimize predictor accuracy.
|
|
1399
1411
|
* To apply an AutoML strategy that minimizes training time, use
|
|
1400
1412
|
* <code>LatencyOptimized</code>.</p>
|
|
1401
1413
|
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
@@ -1486,6 +1498,10 @@ export interface CreatePredictorRequest {
|
|
|
1486
1498
|
* </ul>
|
|
1487
1499
|
*/
|
|
1488
1500
|
Tags?: Tag[];
|
|
1501
|
+
/**
|
|
1502
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
1503
|
+
*/
|
|
1504
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
1489
1505
|
}
|
|
1490
1506
|
export declare namespace CreatePredictorRequest {
|
|
1491
1507
|
/**
|
|
@@ -2409,7 +2425,12 @@ export interface DescribePredictorResponse {
|
|
|
2409
2425
|
*/
|
|
2410
2426
|
PerformAutoML?: boolean;
|
|
2411
2427
|
/**
|
|
2412
|
-
* <
|
|
2428
|
+
* <note>
|
|
2429
|
+
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
2430
|
+
* Contact AWS Support or your account manager to learn more about access privileges.
|
|
2431
|
+
* </p>
|
|
2432
|
+
* </note>
|
|
2433
|
+
* <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
|
|
2413
2434
|
* is specified, the AutoML strategy optimizes predictor accuracy.</p>
|
|
2414
2435
|
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
2415
2436
|
*/
|
|
@@ -2534,6 +2555,10 @@ export interface DescribePredictorResponse {
|
|
|
2534
2555
|
* </ul>
|
|
2535
2556
|
*/
|
|
2536
2557
|
LastModificationTime?: Date;
|
|
2558
|
+
/**
|
|
2559
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
2560
|
+
*/
|
|
2561
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
2537
2562
|
}
|
|
2538
2563
|
export declare namespace DescribePredictorResponse {
|
|
2539
2564
|
/**
|
|
@@ -2658,30 +2683,30 @@ export declare enum EvaluationType {
|
|
|
2658
2683
|
SUMMARY = "SUMMARY"
|
|
2659
2684
|
}
|
|
2660
2685
|
/**
|
|
2661
|
-
* <p>
|
|
2662
|
-
*
|
|
2663
|
-
* part of the <a>Metrics</a> object.
|
|
2664
|
-
* </p>
|
|
2686
|
+
* <p> Provides detailed error metrics to evaluate the performance of a predictor. This object
|
|
2687
|
+
* is part of the <a>Metrics</a> object. </p>
|
|
2665
2688
|
*/
|
|
2666
2689
|
export interface ErrorMetric {
|
|
2667
2690
|
/**
|
|
2668
|
-
* <p>
|
|
2669
|
-
* The Forecast type used to compute WAPE and RMSE.
|
|
2670
|
-
* </p>
|
|
2691
|
+
* <p> The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. </p>
|
|
2671
2692
|
*/
|
|
2672
2693
|
ForecastType?: string;
|
|
2673
2694
|
/**
|
|
2674
|
-
* <p>
|
|
2675
|
-
* The weighted absolute percentage error (WAPE).
|
|
2676
|
-
* </p>
|
|
2695
|
+
* <p> The weighted absolute percentage error (WAPE). </p>
|
|
2677
2696
|
*/
|
|
2678
2697
|
WAPE?: number;
|
|
2679
2698
|
/**
|
|
2680
|
-
* <p>
|
|
2681
|
-
* The root-mean-square error (RMSE).
|
|
2682
|
-
* </p>
|
|
2699
|
+
* <p> The root-mean-square error (RMSE). </p>
|
|
2683
2700
|
*/
|
|
2684
2701
|
RMSE?: number;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The Mean Absolute Scaled Error (MASE)</p>
|
|
2704
|
+
*/
|
|
2705
|
+
MASE?: number;
|
|
2706
|
+
/**
|
|
2707
|
+
* <p>The Mean Absolute Percentage Error (MAPE)</p>
|
|
2708
|
+
*/
|
|
2709
|
+
MAPE?: number;
|
|
2685
2710
|
}
|
|
2686
2711
|
export declare namespace ErrorMetric {
|
|
2687
2712
|
/**
|
|
@@ -2690,14 +2715,13 @@ export declare namespace ErrorMetric {
|
|
|
2690
2715
|
const filterSensitiveLog: (obj: ErrorMetric) => any;
|
|
2691
2716
|
}
|
|
2692
2717
|
/**
|
|
2693
|
-
* <p>The weighted loss value for a quantile. This object is part of the
|
|
2694
|
-
* <a>Metrics</a> object.</p>
|
|
2718
|
+
* <p>The weighted loss value for a quantile. This object is part of the <a>Metrics</a> object.</p>
|
|
2695
2719
|
*/
|
|
2696
2720
|
export interface WeightedQuantileLoss {
|
|
2697
2721
|
/**
|
|
2698
2722
|
* <p>The quantile. Quantiles divide a probability distribution into regions of equal
|
|
2699
|
-
* probability. For example, if the distribution was divided into 5 regions of equal
|
|
2700
|
-
*
|
|
2723
|
+
* probability. For example, if the distribution was divided into 5 regions of equal probability,
|
|
2724
|
+
* the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>
|
|
2701
2725
|
*/
|
|
2702
2726
|
Quantile?: number;
|
|
2703
2727
|
/**
|
|
@@ -2713,8 +2737,8 @@ export declare namespace WeightedQuantileLoss {
|
|
|
2713
2737
|
const filterSensitiveLog: (obj: WeightedQuantileLoss) => any;
|
|
2714
2738
|
}
|
|
2715
2739
|
/**
|
|
2716
|
-
* <p>Provides metrics that are used to evaluate the performance of a predictor. This object
|
|
2717
|
-
*
|
|
2740
|
+
* <p>Provides metrics that are used to evaluate the performance of a predictor. This object is
|
|
2741
|
+
* part of the <a>WindowSummary</a> object.</p>
|
|
2718
2742
|
*/
|
|
2719
2743
|
export interface Metrics {
|
|
2720
2744
|
/**
|
|
@@ -2729,12 +2753,15 @@ export interface Metrics {
|
|
|
2729
2753
|
*/
|
|
2730
2754
|
WeightedQuantileLosses?: WeightedQuantileLoss[];
|
|
2731
2755
|
/**
|
|
2732
|
-
* <p>
|
|
2733
|
-
*
|
|
2734
|
-
* average percentage error (WAPE).
|
|
2735
|
-
* </p>
|
|
2756
|
+
* <p> Provides detailed error metrics for each forecast type. Metrics include root-mean
|
|
2757
|
+
* square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE),
|
|
2758
|
+
* and weighted average percentage error (WAPE). </p>
|
|
2736
2759
|
*/
|
|
2737
2760
|
ErrorMetrics?: ErrorMetric[];
|
|
2761
|
+
/**
|
|
2762
|
+
* <p>The average value of all weighted quantile losses.</p>
|
|
2763
|
+
*/
|
|
2764
|
+
AverageWeightedQuantileLoss?: number;
|
|
2738
2765
|
}
|
|
2739
2766
|
export declare namespace Metrics {
|
|
2740
2767
|
/**
|
|
@@ -2743,11 +2770,10 @@ export declare namespace Metrics {
|
|
|
2743
2770
|
const filterSensitiveLog: (obj: Metrics) => any;
|
|
2744
2771
|
}
|
|
2745
2772
|
/**
|
|
2746
|
-
* <p>The metrics for a time range within the evaluation portion of a dataset. This object
|
|
2747
|
-
*
|
|
2748
|
-
* <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are
|
|
2749
|
-
*
|
|
2750
|
-
* <a>EvaluationParameters</a> object.</p>
|
|
2773
|
+
* <p>The metrics for a time range within the evaluation portion of a dataset. This object is
|
|
2774
|
+
* part of the <a>EvaluationResult</a> object.</p>
|
|
2775
|
+
* <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are determined
|
|
2776
|
+
* by the <code>BackTestWindowOffset</code> parameter of the <a>EvaluationParameters</a> object.</p>
|
|
2751
2777
|
*/
|
|
2752
2778
|
export interface WindowSummary {
|
|
2753
2779
|
/**
|
|
@@ -2788,8 +2814,7 @@ export declare namespace WindowSummary {
|
|
|
2788
2814
|
const filterSensitiveLog: (obj: WindowSummary) => any;
|
|
2789
2815
|
}
|
|
2790
2816
|
/**
|
|
2791
|
-
* <p>The results of evaluating an algorithm. Returned as part of the
|
|
2792
|
-
* <a>GetAccuracyMetrics</a> response.</p>
|
|
2817
|
+
* <p>The results of evaluating an algorithm. Returned as part of the <a>GetAccuracyMetrics</a> response.</p>
|
|
2793
2818
|
*/
|
|
2794
2819
|
export interface EvaluationResult {
|
|
2795
2820
|
/**
|
|
@@ -2798,8 +2823,8 @@ export interface EvaluationResult {
|
|
|
2798
2823
|
AlgorithmArn?: string;
|
|
2799
2824
|
/**
|
|
2800
2825
|
* <p>The array of test windows used for evaluating the algorithm. The
|
|
2801
|
-
*
|
|
2802
|
-
*
|
|
2826
|
+
* <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a> object
|
|
2827
|
+
* determines the number of windows in the array.</p>
|
|
2803
2828
|
*/
|
|
2804
2829
|
TestWindows?: WindowSummary[];
|
|
2805
2830
|
}
|
|
@@ -2815,11 +2840,20 @@ export interface GetAccuracyMetricsResponse {
|
|
|
2815
2840
|
*/
|
|
2816
2841
|
PredictorEvaluationResults?: EvaluationResult[];
|
|
2817
2842
|
/**
|
|
2818
|
-
* <
|
|
2843
|
+
* <note>
|
|
2844
|
+
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
2845
|
+
* Contact AWS Support or your account manager to learn more about access privileges.
|
|
2846
|
+
* </p>
|
|
2847
|
+
* </note>
|
|
2848
|
+
* <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
|
|
2819
2849
|
* is specified, the AutoML strategy optimizes predictor accuracy.</p>
|
|
2820
2850
|
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
2821
2851
|
*/
|
|
2822
2852
|
AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
2855
|
+
*/
|
|
2856
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
2823
2857
|
}
|
|
2824
2858
|
export declare namespace GetAccuracyMetricsResponse {
|
|
2825
2859
|
/**
|