Skip to content

Commit

Permalink
Readme file creation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor Henrique Alves Ribeiro committed May 13, 2020
1 parent 4bedaba commit 1eb9d87
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 1 deletion.
File renamed without changes.
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[![View Ensemble Learning Toolbox on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/68383-ensemble-learning-toolbox)

# Ensemble Learning Toolbox

This is a toolbox to enable the creation of custom ensembles in MATLAB.
It is possible to create a desired ensemble model using just a few lines of code.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

You just need MATLAB and the Statistics and Machine Learning Toolbox.
This toolbox has been developed on MATLAB R2019a, but should also be compatible with earlier versions.

### Installing

Toolbox installation in MATLAB is rather simple.
You just need to add a copy of the source codes (src directory) in the MATLAB paths.

This can be made programatically with the following code:

```
addpath('<directory>/ELT/src')
```

Two simple demos can be found in the examples directory.
To run them, you just need to execute the scripts Demo_classification.m and Demo_regression.m.

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

* MATLAB R2019a

## Contributing

Please contact the author ([email protected]).

## Versioning

We use a three codes versioning system: vA.B.C.
A stands for the major revision, and will be used when a major new feature is added or compatibility to previous major revision is lost.
B stands for minor revision, where new features will be added.
C is used for fixing bugs in the code.

## Authors

* **Victor Henrique Alves Ribeiro, MSc** - *Coding* - Industrial and Systems Engineering Graduate Program, Pontifícia Universidade Católica do Paraná - Brazil
* **Gilberto Reynoso-Meza, PhD** - *Supervision* - Industrial and Systems Engineering Graduate Program, Pontifícia Universidade Católica do Paraná - Brazil

## License

This project is licensed under the 3-clause BSD License - see the [LICENSE.txt](LICENSE.txt) file for details
1 change: 0 additions & 1 deletion README.md.txt

This file was deleted.

0 comments on commit 1eb9d87

Please sign in to comment.