pyhgf.model.add_ef_state#

pyhgf.model.add_ef_state(network, n_nodes, node_parameters, additional_parameters, value_children=(None, None))[source]#

Add exponential family 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.

  • 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.

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

Returns:

The updated neural network.

Return type:

network