Microsoft Finance Time Series Forecasting Framework (FinnTS) is a forecasting package that utilizes cutting-edge time series forecasting and parallelization on the cloud to produce accurate forecasts for financial data.
Перейти к файлу
Mike Tokic 9a193f9682 dev 2022-07-13 16:43:14 -07:00
.github update r cmd check pipeline with all dependencies 2022-06-29 14:18:03 -07:00
R dev 2022-07-13 16:43:14 -07:00
man final updates after testing run_model_parallel argument with spark 2022-06-29 14:02:17 -07:00
tests make tests run under 5 min to comply with CRAN submission R CMD Check time limit of under 10 minutes 2022-01-14 08:50:18 -08:00
vignettes final updates after testing run_model_parallel argument with spark 2022-06-29 14:02:17 -07:00
.Rbuildignore cran release update 2021-11-23 14:39:01 -08:00
.gitignore github action files to automatically update github pages site once new branches are pushed to main 2021-09-02 09:54:04 -07:00
CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md committed 2021-07-02 09:53:43 -07:00
DESCRIPTION add error handling for simple model averages 2022-06-22 11:14:04 -07:00
LICENSE update to MIT License to comply with CRAN policy 2022-01-13 09:06:59 -08:00
LICENSE.md update to MIT License to comply with CRAN policy 2022-01-13 09:06:59 -08:00
NAMESPACE final function import docs 2022-03-25 11:37:49 -07:00
NEWS.md doc update 2022-06-29 14:05:05 -07:00
README.md update documentation 2022-06-30 20:00:11 -07:00
SECURITY.md SECURITY.md committed 2021-07-02 09:53:45 -07:00
SUPPORT.md SUPPORT.md committed 2021-07-02 09:53:46 -07:00
_pkgdown.yml final push before PR 2021-11-17 19:37:16 -08:00
cran-comments.md cran submission 2022-03-28 15:10:09 -07:00

README.md

Microsoft Finance Time Series Forecasting Framework

CRAN\_Status\_Badge

The Microsoft Finance Time Series Forecasting Framework, aka finnts or Finn, is an automated forecasting framework for producing financial forecasts. While it was built for corporate finance activities, it can easily expand to any time series forecasting problem!

  • Automated feature engineering, back testing, and model selection.
  • Access to 25+ models. Univariate, multivariate, and deep learning models all included.
  • Azure integration to run thousands of time series in parallel within the cloud.
  • Supports daily, weekly, monthly, quarterly, and yearly forecasts.
  • Handles external regressors, either purely historical or historical+future values.

Installation

CRAN version

install.packages("finnts")

Development version

To get a bug fix or to use a feature from the development version, you can install the development version of finnts from GitHub.

# install.packages("devtools")
devtools::install_github("microsoft/finnts")

Usage

library(finnts)

# prepare historical data
hist_data <- timetk::m4_monthly %>%
  dplyr::rename(Date = date) %>%
  dplyr::mutate(id = as.character(id))

# call main finnts modeling function
finn_output <- forecast_time_series(
  input_data = hist_data,
  combo_variables = c("id"),
  target_variable = "value",
  date_type = "month",
  forecast_horizon = 3,
  back_test_scenarios = 6, 
  models_to_run = c("arima", "ets"), 
  run_global_models = FALSE, 
  run_model_parallel = FALSE
)

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.