Metadata-Version: 2.1
Name: mbtr
Version: 0.1.1
Summary: Multivariate Boosted Trees Regressor package
Home-page: https://github.com/supsi-dacd-isaac/mbtr
Author: Lorenzo Nespoli
Author-email: lorenzo.nespoli@supsi.ch
License: UNKNOWN
Description: <img src="docs/source/_static/logo.svg"> 
        
        [![Documentation Status](https://readthedocs.org/projects/mbtr/badge/?version=master)](https://mbtr.readthedocs.io/en/master/?badge=master)
        [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
        [![Build Status](https://travis-ci.org/supsi-dacd-isaac/mbtr.svg?branch=master)](https://travis-ci.org/supsi-dacd-isaac/mbtr)
        
        # Multivariate Boosted TRee
        
        ## What is MBTR
        
        MBTR is a python package for multivariate boosted tree regressors trained in parameter space. 
        The package can handle arbitrary multivariate losses, as long as their gradient and Hessian are known.
        Gradient boosted trees are competition-winning, general-purpose, non-parametric regressors, which exploit sequential model fitting and gradient descent to minimize a specific loss function. The most popular implementations are tailored to univariate regression and classification tasks, precluding the possibility of capturing multivariate target cross-correlations and applying conditional penalties to the predictions. This package allows to arbitrarily regularize the predictions, so that properties like smoothness, consistency and functional relations can be
        enforced.
        
        ## Installation
        
        ```sh
        pip install --upgrade git+https://github.com/supsi-dacd-isaac/mbtr.git
        ```
        
        ## Usage 
        
        MBT regressor follows the scikit-learn syntax for regressors. Creating a default instance and training it is as simple as:
        ```python
        m = MBT().fit(x,y)
        ```
        while predictions for the test set are obtained through 
        
        ```python
        y_hat = m.predict(x_te)
        ```
        The most important parameters are the number of boosts `n_boost`, that is, the number of fitted trees, `learning_rate` and the `loss_type`. An extensive explanation of the different parameters can be found in the documentation. 
        
        
        
        ## Documentation 
        
        Documentation and examples on the usage can be found at [docs](https://mbtr.readthedocs.io/en/master/?badge=master).
        
        ## Reference
        
        If you make use of this software for your work, we would appreciate it if you would cite us:
        
        *Lorenzo Nespoli and Vasco Medici (2020).
        Multivariate Boosted Trees and Applications to Forecasting and Control*
        [arXiv](https://arxiv.org/abs/2003.03835)
        
            @article{nespoli2020multivariate,
              title={Multivariate Boosted Trees and Applications to Forecasting and Control},
              author={Nespoli, Lorenzo and Medici, Vasco},
              journal={arXiv preprint arXiv:2003.03835},
              year={2020}
            }
        
        ## Aknowledgments
        
        The authors would like to thank the Swiss Federal Office of Energy (SFOE) and the
        Swiss Competence Center for Energy Research - Future Swiss Electrical Infrastructure (SCCER-FURIES),
        for their financial and technical support to this research work.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
