neupy.algorithms.associative.instar module

class neupy.algorithms.associative.instar.Instar[source]

Instar is a simple unsupervised Neural Network algortihm which detects associations.

Parameters:

n_inputs : int

Number of input units.

n_outputs : int

Number of output units.

n_unconditioned : int

Number of unconditioned units in neraul networks. All these units wouldn’t update during the training procedure. Unconditioned should be the first feature in the dataset.

weight : array-like, Initializer

Neural network weights. Value defined manualy should have shape (n_inputs, n_outputs). Defaults to Normal().

bias : array-like, Initializer

Neural network bias units. Defaults to Constant(-0.5).

step : float

Learning rate, defaults to 0.1.

show_epoch : int or str

This property controls how often the network will display information about training. There are two main syntaxes for this property.

  • You can define it as a positive integer number. It defines how offen would you like to see summary output in terminal. For instance, number 100 mean that network shows summary at 100th, 200th, 300th ... epochs.
  • String defines number of times you want to see output in terminal. For instance, value '2 times' mean that the network will show output twice with approximately equal period of epochs and one additional output would be after the finall epoch.

Defaults to 1.

shuffle_data : bool

If it’s True class shuffles all your training data before training your network, defaults to True.

epoch_end_signal : function

Calls this function when train epoch finishes.

train_end_signal : function

Calls this function when train process finishes.

verbose : bool

Property controls verbose output interminal. True enables informative output in the terminal and False - disable it. Defaults to False.

Examples

>>> import numpy as np
>>> from neupy import algorithms
>>>
>>> train_data = np.array([
...     [0, 1, 0, 0],
...     [1, 1, 0, 0],
... ])
>>> test_cases = np.array([
...     [0, 1, 0, 0],
...     [0, 0, 0, 0],
...     [0, 0, 1, 1],
... ])
>>>
>>> instnet = algorithms.Instar(
...     n_inputs=4,
...     n_outputs=1,
...     n_unconditioned=1,
...     step=1,
...     verbose=False,
... )
>>>
>>> instnet.train(train_data, epochs=2)
>>> instnet.predict(test_cases)
array([[1],
       [0],
       [0]])

Methods

predict(input_data) Predicts output for the specified input.
train(input_train, summary=’table’, epochs=100) Train neural network.
fit(*args, **kwargs) Alias to the train method.
options = {'verbose': Option(class_name='Verbose', value=VerboseProperty(name="verbose")), 'weight': Option(class_name='BaseStepAssociative', value=ArrayProperty(name="weight")), 'shuffle_data': Option(class_name='BaseNetwork', value=Property(name="shuffle_data")), 'train_end_signal': Option(class_name='BaseNetwork', value=Property(name="train_end_signal")), 'step': Option(class_name='BaseNetwork', value=NumberProperty(name="step")), 'bias': Option(class_name='BaseStepAssociative', value=ParameterProperty(name="bias")), 'n_inputs': Option(class_name='BaseStepAssociative', value=IntProperty(name="n_inputs")), 'epoch_end_signal': Option(class_name='BaseNetwork', value=Property(name="epoch_end_signal")), 'show_epoch': Option(class_name='BaseNetwork', value=ShowEpochProperty(name="show_epoch")), 'n_outputs': Option(class_name='BaseAssociative', value=IntProperty(name="n_outputs")), 'n_unconditioned': Option(class_name='BaseStepAssociative', value=IntProperty(name="n_unconditioned"))}[source]
weight_delta(input_row, layer_output)[source]