Metadata-Version: 2.1
Name: quicksemble
Version: 0.2.5
Summary: A package to build ensemble for quick experiments.
Home-page: https://github.com/SubigyaPanta/quicksemble
Author: Subigya Jyoti Panta
Author-email: subigya@t2pco.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/SubigyaPanta/quicksemble/issues
Project-URL: Source, https://github.com/SubigyaPanta/quicksemble
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: scikit-learn
Requires-Dist: xgboost

# Quicksemble
[![Downloads](https://pepy.tech/badge/quicksemble)](https://pepy.tech/project/quicksemble)

**Quicksemble** is a simple package to create a stacked ensemble for quick 
experiments. It is developed in [T2P Co., Ltd.](https://www.t2pco.com/)  

### Dependencies
1. Numpy `pip install numpy`
2. Scikit Learn `pip install scikit-learn`
3. Xgboost `pip install xgboost`

## Installation
`pip install quicksemble`

## Basic Usage
```python
from sklearn.ensemble import RandomForestClassifier
from xgboost import XGBClassifier
from quicksemble.ensembler import Ensembler

#
# Define train and test dataset here
#

models = [
    RandomForestClassifier(random_state=21),
    XGBClassifier(random_state=21)
]
# Default meta classifier is LogisticRegression. Hence it is weighted voting.
ensemble = Ensembler(models)
ensemble.fit(X_train, y_train)
ensemble.predict(X_test)

```

To change the default meta classifer:
```python
from sklearn.ensemble import RandomForestClassifier
from xgboost import XGBClassifier
from quicksemble.ensembler import Ensembler

#
# Define train and test dataset here
#

models = [
    RandomForestClassifier(random_state=21),
    XGBClassifier(random_state=21)
]

# Use Neural Network as meta classifier
ensemble = Ensembler(models, meta_model=MLPClassifier())
ensemble.fit(X_train, y_train)
ensemble.predict(X_test)
```

By default, Base models use "hard" voting, i.e., it outputs predictions of the 
base models. We can switch it to "soft" voting, i.e., it outputs probabilities
of each class by the base model.

To change voting style:
```python
from sklearn.ensemble import RandomForestClassifier
from xgboost import XGBClassifier
from quicksemble.ensembler import Ensembler

#
# Define train and test dataset here
#

models = [
    RandomForestClassifier(random_state=21),
    XGBClassifier(random_state=21)
]

# Use soft voting. 
ensemble = Ensembler(models, voting='soft')
ensemble.fit(X_train, y_train)
ensemble.predict(X_test)
```

To view output of intermediary state i.e., output of base layers (layer 1)
that is going into meta layer (layer 2). Internally, it uses Pipelines from
scikit-learn. So, feel free to read docs about pipelines.
```python
ensemble = Ensembler(models, voting='soft')
ensemble.fit(X_train, y_train)

# This line will output the values. Note that you need to fit it first.
ensemble.ensemble.named_steps['base_layer'].transform(X_train)
```

For already saved models, use modelpaths. Note that it should be pickled.
````python
es = Ensembler(modelpaths=[
            'rf.pkl',
            'xg.pkl'
    ])
es.fit(X_train, y_train)
es.predict(X_train)
````


