Make Predictions from a "OnlineMultiLogisticRegression" Object

Similar to other predict methods, this function predicts fitted values from a fitted "OnlineMultiLogisticRegression" object.

# S3 method for OnlineMultiLogisticRegression
predict(model, data, key, features = NULL, thread.ratio = NULL)

Arguments

model	R6Class object A "OnlineMultiLogisticRegression" object for prediction.
data	DataFrame DataFrame containting the data.
key	character Name of the ID column.
features	character of list of characters, optional Name of feature columns for prediction. If not provided, it defaults to all non-key columns of data.
thread.ratio	double, optional Controls the proportion of available threads that can be used by this function. The value range is from 0 to 1, where 0 indicates a single thread, and 1 indicates all available threads. Values between 0 and 1 will use up to that percentage of available threads.Values outside this range are ignored. Defaults to 0.

Format

S3 methods

Value

Returns a Dataframe
containing predicted values, characteructured as follows.

• ID column, with same name and type as `data`'s ID column.

• CLASS, type NVARCHAR, predicted class name.

• PROBABILITY, type DOUBLE.

Examples

omlr is an "OnlineMultiLogisticRegression" object.
Call predict() with df.predict:

> df.predict$Collect
   ID   X1   X2
0   1  1.2  0.7
1   2  1.0 -2.0

Invoke predict():

> fitted <- predict(omlr, df.predict, key="ID", features=list("X1", "X2"))
> fitted$Collect
   ID CLASS  PROBABILITY
0   1     0     0.539350
1   2     2     0.830026

See also

hanaml.OnlineMultiLogisticRegression