Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

TimeSeriesPredictionEngine<TSrc,TDst>.Predict Method

Definition

Namespace:
Microsoft.ML.Transforms.TimeSeries
Assembly:
Microsoft.ML.TimeSeries.dll
Package:
Microsoft.ML.TimeSeries v4.0.1
Package:
Microsoft.ML.TimeSeries v1.2.0
Package:
Microsoft.ML.TimeSeries v1.3.1
Package:
Microsoft.ML.TimeSeries v1.4.0
Package:
Microsoft.ML.TimeSeries v1.5.5
Package:
Microsoft.ML.TimeSeries v1.6.0
Package:
Microsoft.ML.TimeSeries v1.7.0
Package:
Microsoft.ML.TimeSeries v2.0.1
Package:
Microsoft.ML.TimeSeries v3.0.1
Package:
Microsoft.ML.TimeSeries v5.0.0-preview.1.25125.4

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Predict(Nullable<Int32>, Nullable<Single>)

Forecasting only task.
Predict(TSrc, TDst)

Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation. For anomaly detection the model is always updated with example.
Predict(TSrc, Nullable<Int32>, Nullable<Single>)

Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation.
Predict(TSrc, TDst, Nullable<Int32>, Nullable<Single>)

Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation. For anomaly detection the model is always updated with example.

Predict(Nullable<Int32>, Nullable<Single>)

Source:
PredictionEngine.cs
Source:
PredictionEngine.cs
Source:
PredictionEngine.cs

Forecasting only task.

public TDst Predict(int? horizon = default, float? confidenceLevel = default);
override this.Predict : Nullable<int> * Nullable<single> -> 'Dst
Public Function Predict (Optional horizon As Nullable(Of Integer) = Nothing, Optional confidenceLevel As Nullable(Of Single) = Nothing) As TDst

Parameters

horizon
Nullable<Int32>

Number of values to forecast.

confidenceLevel
Nullable<Single>

Confidence level for forecasting.

Returns

TDst

Applies to

Predict(TSrc, TDst)

Source:
PredictionEngine.cs
Source:
PredictionEngine.cs
Source:
PredictionEngine.cs

Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation. For anomaly detection the model is always updated with example.

public override void Predict(TSrc example, ref TDst prediction);
override this.Predict : 'Src * 'Dst -> unit
Public Overrides Sub Predict (example As TSrc, ByRef prediction As TDst)

Parameters

example
TSrc

Input to the prediction engine.

prediction
TDst

Forecasting/Prediction from the engine.

Applies to

Predict(TSrc, Nullable<Int32>, Nullable<Single>)

Source:
PredictionEngine.cs
Source:
PredictionEngine.cs
Source:
PredictionEngine.cs

Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation.

public TDst Predict(TSrc example, int? horizon = default, float? confidenceLevel = default);
override this.Predict : 'Src * Nullable<int> * Nullable<single> -> 'Dst
Public Function Predict (example As TSrc, Optional horizon As Nullable(Of Integer) = Nothing, Optional confidenceLevel As Nullable(Of Single) = Nothing) As TDst

Parameters

example
TSrc

Input to the prediction engine.

horizon
Nullable<Int32>

Number of values to forecast.

confidenceLevel
Nullable<Single>

Confidence level for forecasting.

Returns

TDst

Prediction/Forecasting after the model has been updated with example

Applies to

Predict(TSrc, TDst, Nullable<Int32>, Nullable<Single>)

Source:
PredictionEngine.cs
Source:
PredictionEngine.cs
Source:
PredictionEngine.cs

Performs prediction. In the case of forecasting only task example can be left as null. If example is not null then it could be used to update forecasting models with new obervation. For anomaly detection the model is always updated with example.

public void Predict(TSrc example, ref TDst prediction, int? horizon = default, float? confidenceLevel = default);
override this.Predict : 'Src * 'Dst * Nullable<int> * Nullable<single> -> unit
Public Sub Predict (example As TSrc, ByRef prediction As TDst, Optional horizon As Nullable(Of Integer) = Nothing, Optional confidenceLevel As Nullable(Of Single) = Nothing)

Parameters

example
TSrc

Input to the prediction engine.

prediction
TDst

Forecasting/Prediction from the engine.

horizon
Nullable<Int32>

Used to indicate the number of values to forecast.

confidenceLevel
Nullable<Single>

Used in forecasting model for confidence.

Applies to