Skip to content

Commit

Permalink
Update Readme and bump version number
Browse files Browse the repository at this point in the history
  • Loading branch information
titu1994 committed Nov 16, 2019
1 parent f892e11 commit 520bbd4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,19 @@ $ pip install tabnet[gpu]
The script `tabnet.py` can be imported to yield either the `TabNet` building block, or the `TabNetClassification` and `TabNetRegression` models, which add appropriate heads for the basic `TabNet` model. If the classification or regression head is to be customized, it is recommended to compose a new model with the `TabNet` as the base of the model.

```python
from tabnet import TabNet, TabNetClassification
from tabnet import TabNet, TabNetClassifier

model = TabNetClassification(feature_list, num_classes, ...)
model = TabNetClassifier(feature_list, num_classes, ...)
```

## Stacked TabNets

Regular TabNets can be stacked into various layers, thereby reducing interpretability but improving model capacity.

```python
from tabnet import StackedTabNetClassifier

model = TabNetClassifier(feature_list, num_classes, num_layers, ...)
```

As the models use custom objects, it is necessary to import `custom_objects.py` in an evaluation only script.
Expand Down
2 changes: 1 addition & 1 deletion tabnet/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
__all__ = ['TabNet', 'TabNetClassifier', 'TabNetRegressor',
'StackedTabNet', 'StackedTabNetClassifier', 'StackedTabNetRegressor']

__version__ = '0.1.3'
__version__ = '0.1.4'

0 comments on commit 520bbd4

Please sign in to comment.