pyhgf.model.add_binary_state

pyhgf.model.add_binary_state(network, n_nodes, value_parents, volatility_parents, value_children, volatility_children, node_parameters, additional_parameters)

Add binary state node(s) to a network.

Parameters:

• network (Network) – The neural network to which the node(s) are added.

• n_nodes (int) – The number of identical node(s) to add.

• value_parents – The value parents of the node(s), as a tuple of indexes and coupling strengths.

• volatility_parents – The volatility parents of the node(s), as a tuple of indexes and coupling strengths.

• value_children – The value children of the node(s), as a tuple of indexes and coupling strengths.

• volatility_children – The volatility children of the node(s), as a tuple of indexes and coupling strengths.

• node_parameters (dict) – A dictionary of parameters overriding the node defaults.

• additional_parameters (dict) – Additional parameters passed as keyword arguments, validated against the node defaults.

Returns:

The updated neural network.

Return type:

network