The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.

Time series modelling with neural networks for R: nnfor package

CRAN_Status_Badge Downloads

Development repository for the nnfor package for R. Stable version available on CRAN.

Installing

To install the development version from GitHub use:

if (!requireNamespace("remotes", quietly = TRUE)) install.packages("remotes")
remotes::install_github("trnnick/tsutils")  # nnfor needs tsutils >= 0.9.5
remotes::install_github("trnnick/nnfor")

Otherwise, install the stable version from CRAN:

install.packages("nnfor")

Backends

mlp() trains networks with neuralnet by default, which is installed with nnfor. As an option, networks can be trained with torch, which offers modern activation functions (e.g. tanh, ReLU, GELU, SiLU) and optimizers (e.g. Adam, AdamW, RMSprop), custom architectures, and trains all networks of an ensemble simultaneously. torch is not needed for anything else in nnfor, so it does not have to be installed.

To use torch, install the package and then its libraries (a one-off download of a few hundred MB):

install.packages("torch")
torch::install_torch()

See the torch installation guide if this step fails. Then choose the backend when fitting:

library(nnfor)
# torch with neuralnet's training setup (logistic activation, Rprop)
fit <- mlp(AirPassengers, backend = "torch")
# torch with the settings suggested in ?mlp
fit <- mlp(AirPassengers, backend = "torch", act.fct = "gelu",
           algorithm = "adam", learningrate = 0.01, stepmax = 3000)
plot(forecast(fit, h = 24))

Settings accept neuralnet’s names (e.g. act.fct = "logistic", algorithm = "rprop+") as well as torch’s. With torch, hd can also be a function returning a custom architecture. Networks are trained on the CPU, which is efficient for networks of this size.

To compare the backends on a series, with run times and in-sample and out-of-sample errors:

cmp <- compare_backends(AirPassengers)
print(cmp)
plot(cmp)

?mlp describes the torch settings and the differences between the backends, and plot(nnfor_map("mlp")) shows where training sits among the modelling steps.

Tutorial

You can find a tutorial on using nnfor for time series forecasting here.

Author

Nikolaos Kourentzes - (http://nikolaos.kourentzes.com/)

References

License

This project is licensed under the GPL3 License

Happy forecasting!

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.