A scikit-learn compatible neural network library that wraps PyTorch.
To see more elaborate examples, look here.
import numpy as np
from sklearn.datasets import make_classification
from torch import nn
import torch.nn.functional as F
from skorch import NeuralNetClassifier
X, y = make_classification(1000, 20, n_informative=10, random_state=0)
X = X.astype(np.float32)
y = y.astype(np.int64)
class MyModule(nn.Module):
def __init__(self, num_units=10, nonlin=F.relu):
super(MyModule, self).__init__()
self.dense0 = nn.Linear(20, num_units)
self.nonlin = nonlin
self.dropout = nn.Dropout(0.5)
self.dense1 = nn.Linear(num_units, 10)
self.output = nn.Linear(10, 2)
def forward(self, X, **kwargs):
X = self.nonlin(self.dense0(X))
X = self.dropout(X)
X = F.relu(self.dense1(X))
X = F.softmax(self.output(X), dim=-1)
return X
net = NeuralNetClassifier(
MyModule,
max_epochs=10,
lr=0.1,
# Shuffle training data on each epoch
iterator_train__shuffle=True,
)
net.fit(X, y)
y_proba = net.predict_proba(X)
In an sklearn Pipeline:
from sklearn.pipeline import Pipeline
from sklearn.preprocessing import StandardScaler
pipe = Pipeline([
('scale', StandardScaler()),
('net', net),
])
pipe.fit(X, y)
y_proba = pipe.predict_proba(X)
With grid search
from sklearn.model_selection import GridSearchCV
params = {
'lr': [0.01, 0.02],
'max_epochs': [10, 20],
'module__num_units': [10, 20],
}
gs = GridSearchCV(net, params, refit=False, cv=3, scoring='accuracy')
gs.fit(X, y)
print(gs.best_score_, gs.best_params_)
skorch also provides many convenient features, among others:
- Learning rate schedulers (Warm restarts, cyclic LR and many more)
- Scoring using sklearn (and custom) scoring functions
- Early stopping
- Checkpointing
- Parameter freezing/unfreezing
- Progress bar (for CLI as well as jupyter)
- Automatic inference of CLI parameters
skorch requires Python 3.5 or higher.
To install with pip, run:
pip install -U skorch
We recommend to use a virtual environment for this.
If you would like to use the must recent additions to skorch or help development, you should install skorch from source:
git clone https://github.com/skorch-dev/skorch.git
cd skorch
# install pytorch version for your system (see below)
python setup.py install
You need a working conda installation. Get the correct miniconda for your system from here.
You can also install skorch through the conda-forge channel. The instructions for doing so are available here. Note: The conda channel is _not_ managed by the skorch maintainers.
If you do not want to use conda-forge, you may install skorch using:
git clone https://github.com/skorch-dev/skorch.git
cd skorch
conda env create
source activate skorch
# install pytorch version for your system (see below)
python setup.py install
If you want to help developing, run:
git clone https://github.com/skorch-dev/skorch.git
cd skorch
conda env create
source activate skorch
# install pytorch version for your system (see below)
conda install -c conda-forge --file requirements-dev.txt
python setup.py develop
py.test # unit tests
pylint skorch # static code checks
If you just want to use skorch, use:
git clone https://github.com/skorch-dev/skorch.git
cd skorch
# create and activate a virtual environment
pip install -r requirements.txt
# install pytorch version for your system (see below)
python setup.py install
If you want to help developing, run:
git clone https://github.com/skorch-dev/skorch.git
cd skorch
# create and activate a virtual environment
pip install -r requirements.txt
# install pytorch version for your system (see below)
pip install -r requirements-dev.txt
python setup.py develop
py.test # unit tests
pylint skorch # static code checks
PyTorch is not covered by the dependencies, since the PyTorch version you need is dependent on your system. For installation instructions for PyTorch, visit the PyTorch website. skorch officially supports the following PyTorch versions:
- 1.1.0
- 1.2.0
- 1.3.1
- 1.4.0
- 1.5.0
In general, this should work (assuming CUDA 9):
# using conda:
conda install pytorch cudatoolkit=9.0 -c pytorch
# using pip
pip install torch
- GitHub issues: bug reports, feature requests, install issues, RFCs, thoughts, etc.
- Slack: We run the #skorch channel on the PyTorch Slack server, for which you can request access here.