create_TRMF: Create a TRMF object
In TRMF: Temporally Regularized Matrix Factorization

create_TRMF

R Documentation

Create a TRMF object

Description

Creates a TRMF object from a data matrix. This function is always needed to initialize a TRMF model.

Usage

create_TRMF(dataM, weight = 1, 
      normalize = c("none", "standard", "robust", "range"),
      normalize.type = c("global", "columnwise", "rowwise"),
      na.action = c("impute", "fail"),
      scaleXm = c("no","project","track"))

Arguments

`dataM`	The data matrix, each column represents a time series.
`weight`	An optional matrix of weights to be used in the fitting process. If used, `sum(w^2*e^2)` is minimized.
`normalize`	Type of scaling/centering for the data. Recommended to reduce bias when using regularization. `none` does nothing, `standard` centers with mean, and scales by `sd()`, `robust` centers with the median and scales by `mad(,constant=1)`, `range` maps to `[0-1]` interval
`normalize.type`	how should normalization be applied. `global` scales and centers matrix by one value. `columnwise` and `rowwise` normalize each column or row separately.
`na.action`	what action to take when data contains NAs
`scaleXm`	Should the columns of Xm be rescaled at each iteration. See details

Details

This function doesn't do any computation, it is the entry point for creating a TRMF model. To train the model or add additional details, see examples. Normalization is recommended in general. Regularization biases the factorization toward zero a little bit, centering changes that to bias towards the mean. Scaling makes the choosing of regularization parameters easier. If the factorization is to be used for forward forecasting, rowwise normalization is not recommended as it could remove some temporal information. If scaleXm = 'project' then the columns of Xm will be rescaled to have sum squared value = 1. If set to 'track' then the scaling factors will be stored and updated and used scale Fm before fitting Xm at each iteration.These options were added to allow for more stable behavior of temporal regularization.

Value

create_TRMF returns an object of class "TRMF" to be passed to other TRMF functions.

Author(s)

Chad Hammerquist

References

Yu, Hsiang-Fu, Nikhil Rao, and Inderjit S. Dhillon. "High-dimensional time series prediction with missing values." arXiv preprint arXiv:1509.08333 (2015).

Examples


# create test data
xm = poly(x = (-10:10)/10,degree=4)
fm = matrix(runif(40),4,10)
Am = xm%*%fm+rnorm(210,0,.2)

# create model
obj = create_TRMF(Am)
obj = TRMF_columns(obj,reg_type ="interval")
obj = TRMF_trend(obj,numTS=4,order=2)
out = train(obj)
plot(out)

TRMF documentation built on June 22, 2024, 10:41 a.m.