skorch.toy

Contains toy functions and classes for quick prototyping and testing.

class skorch.toy.MLPModule(input_units=20, output_units=2, hidden_units=10, num_hidden=1, nonlin=ReLU(), output_nonlin=None, dropout=0, squeeze_output=False)

A simple multi-layer perceptron module.

This can be adapted for usage in different contexts, e.g. binary and multi-class classification, regression, etc.

Parameters

input_unitsint (default=20)

Number of input units.

output_unitsint (default=2)

Number of output units.

hidden_unitsint (default=10)

Number of units in hidden layers.

num_hiddenint (default=1)

Number of hidden layers.

nonlintorch.nn.Module instance (default=torch.nn.ReLU())

Non-linearity to apply after hidden layers.

output_nonlintorch.nn.Module instance or None (default=None)

Non-linearity to apply after last layer, if any.

dropoutfloat (default=0)

Dropout rate. Dropout is applied between layers.

squeeze_outputbool (default=False)

Whether to squeeze output. Squeezing can be helpful if you wish your output to be 1-dimensional (e.g. for NeuralNetBinaryClassifier).

Methods

add_module(name, module)	Add a child module to the current module.
apply(fn)	Apply fn recursively to every submodule (as returned by .children()) as well as self.
bfloat16()	Casts all floating point parameters and buffers to bfloat16 datatype.
buffers([recurse])	Return an iterator over module buffers.
children()	Return an iterator over immediate children modules.
compile(*args, **kwargs)	Compile this Module's forward using torch.compile().
cpu()	Move all model parameters and buffers to the CPU.
cuda([device])	Move all model parameters and buffers to the GPU.
double()	Casts all floating point parameters and buffers to double datatype.
eval()	Set the module in evaluation mode.
extra_repr()	Set the extra representation of the module.
float()	Casts all floating point parameters and buffers to float datatype.
forward(X)	Define the computation performed at every call.
get_buffer(target)	Return the buffer given by target if it exists, otherwise throw an error.
get_extra_state()	Return any extra state to include in the module's state_dict.
get_parameter(target)	Return the parameter given by target if it exists, otherwise throw an error.
get_submodule(target)	Return the submodule given by target if it exists, otherwise throw an error.
half()	Casts all floating point parameters and buffers to half datatype.
ipu([device])	Move all model parameters and buffers to the IPU.
load_state_dict(state_dict[, strict, assign])	Copy parameters and buffers from state_dict into this module and its descendants.
modules()	Return an iterator over all modules in the network.
named_buffers([prefix, recurse, ...])	Return an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
named_children()	Return an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
named_modules([memo, prefix, remove_duplicate])	Return an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
named_parameters([prefix, recurse, ...])	Return an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
parameters([recurse])	Return an iterator over module parameters.
register_backward_hook(hook)	Register a backward hook on the module.
register_buffer(name, tensor[, persistent])	Add a buffer to the module.
register_forward_hook(hook, *[, prepend, ...])	Register a forward hook on the module.
register_forward_pre_hook(hook, *[, ...])	Register a forward pre-hook on the module.
register_full_backward_hook(hook[, prepend])	Register a backward hook on the module.
register_full_backward_pre_hook(hook[, prepend])	Register a backward pre-hook on the module.
register_load_state_dict_post_hook(hook)	Register a post hook to be run after module's load_state_dict is called.
register_module(name, module)	Alias for add_module().
register_parameter(name, param)	Add a parameter to the module.
register_state_dict_pre_hook(hook)	Register a pre-hook for the load_state_dict() method.
requires_grad_([requires_grad])	Change if autograd should record operations on parameters in this module.
reset_params()	(Re)set all parameters.
set_extra_state(state)	Set extra state contained in the loaded state_dict.
share_memory()	See torch.Tensor.share_memory_().
state_dict(*args[, destination, prefix, ...])	Return a dictionary containing references to the whole state of the module.
to(*args, **kwargs)	Move and/or cast the parameters and buffers.
to_empty(*, device[, recurse])	Move the parameters and buffers to the specified device without copying storage.
train([mode])	Set the module in training mode.
type(dst_type)	Casts all parameters and buffers to dst_type.
xpu([device])	Move all model parameters and buffers to the XPU.
zero_grad([set_to_none])	Reset gradients of all model parameters.

__call__

forward(X)

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

reset_params()

(Re)set all parameters.

skorch.toy.make_binary_classifier(squeeze_output=True, **kwargs)

Return a multi-layer perceptron to be used with NeuralNetBinaryClassifier.

Parameters

input_unitsint (default=20)

Number of input units.

output_unitsint (default=2)

Number of output units.

hidden_unitsint (default=10)

Number of units in hidden layers.

num_hiddenint (default=1)

Number of hidden layers.

nonlintorch.nn.Module instance (default=torch.nn.ReLU())

Non-linearity to apply after hidden layers.

dropoutfloat (default=0)

Dropout rate. Dropout is applied between layers.

skorch.toy.make_classifier(output_nonlin=Softmax(dim=-1), **kwargs)

Return a multi-layer perceptron to be used with NeuralNetClassifier.

Parameters

input_unitsint (default=20)

Number of input units.

output_unitsint (default=2)

Number of output units.

hidden_unitsint (default=10)

Number of units in hidden layers.

num_hiddenint (default=1)

Number of hidden layers.

nonlintorch.nn.Module instance (default=torch.nn.ReLU())

Non-linearity to apply after hidden layers.

dropoutfloat (default=0)

Dropout rate. Dropout is applied between layers.

skorch.toy.make_regressor(output_units=1, **kwargs)

Return a multi-layer perceptron to be used with NeuralNetRegressor.

Parameters

input_unitsint (default=20)

Number of input units.

output_unitsint (default=1)

Number of output units.

hidden_unitsint (default=10)

Number of units in hidden layers.

num_hiddenint (default=1)

Number of hidden layers.

nonlintorch.nn.Module instance (default=torch.nn.ReLU())

Non-linearity to apply after hidden layers.

dropoutfloat (default=0)

Dropout rate. Dropout is applied between layers.