Skip to content

Latest commit

 

History

History
226 lines (175 loc) · 7.33 KB

README.md

File metadata and controls

226 lines (175 loc) · 7.33 KB

compboost: Fast and Flexible Component-Wise Boosting Framework

Build Status AppVeyor Build Status Coverage Status license CRAN_Status_Badge status

Documentation | Contributors | Release Notes

Overview

Component-wise boosting applies the boosting framework to statistical models, e.g., general additive models using component-wise smoothing splines. Boosting these kinds of models maintains interpretability and enables unbiased model selection in high dimensional feature spaces.

The R package compboost is an alternative implementation of component-wise boosting written in C++ to obtain high runtime performance and full memory control. The main idea is to provide a modular class system which can be extended without editing the source code. Therefore, it is possible to use R functions as well as C++ functions for custom base-learners, losses, logging mechanisms or stopping criteria.

For an introduction and overview about the functionality visit the project page.

Installation

CRAN version:

install.packages("compboost")

Developer version:

devtools::install_github("schalkdaniel/compboost")

Examples

The examples are rendered using compboost 0.1.1.

The fastest way to train a Compboost model is to use the wrapper functions boostLinear() or boostSplines():

cboost = boostSplines(data = iris, target = "Sepal.Length", loss = LossQuadratic$new())

For more extensive examples and how to use the R6 interface visit the project page.

Benchmark

To get an idea of the performance of compboost, we have conduct a small benchmark in which compboost is compared with mboost. For this purpose, the runtime behavior and memory consumption of the two packages were compared. The results of the benchmark can be read here.

Citing

To cite compboost in publications, please use:

Schalk et al., (2018). compboost: Modular Framework for Component-Wise Boosting. Journal of Open Source Software, 3(30), 967, https://doi.org/10.21105/joss.00967

@article{schalk2018compboost,
  author = {Daniel Schalk, Janek Thomas, Bernd Bischl},
  title = {compboost: Modular Framework for Component-Wise Boosting},
  URL = {https://doi.org/10.21105/joss.00967},
  year = {2018},
  publisher = {Journal of Open Source Software},
  volume = {3},
  number = {30},
  pages = {967},
  journal = {JOSS}
}

Testing

On your local machine

In order to test the package functionality you can use devtools to test the package on your local machine:

devtools::test()

Using docker

You can test the package locally using docker and the compboost-test repository:

  • Latest R release:

    docker run schalkdaniel/compboost-test

  • Latest R devel build:

    docker run schalkdaniel/compboost-test:devel