pyhgf.updates.prediction_error.volatile.volatile_node_value_prediction_error#

pyhgf.updates.prediction_error.volatile.volatile_node_value_prediction_error(attributes, node_idx, edges=None)[source]#

Compute the value prediction error of the value level.

This is used by external value parents (if any).

Parameters:
  • attributes (dict) – The attributes of the probabilistic nodes.

  • node_idx (int) – Pointer to the volatile-state node whose value prediction error is computed.

  • edges (tuple[AdjacencyLists, ...] | None) – The edges of the probabilistic nodes as a tuple of pyhgf.typing.AdjacencyLists. Unused; kept for API compatibility with callers that pass edges.

Returns:

The updated attributes of the probabilistic nodes.

Return type:

attributes