fusionlab.nn.components.ExplainableAttention

class fusionlab.nn.components.ExplainableAttention

Bases: Layer, NNLearner

ExplainableAttention layer that returns attention scores from multi-head attention [1].

This layer is useful for interpretability, providing insight into how the attention mechanism focuses on different time steps.

\[\mathbf{A} = \text{MHA}(\mathbf{X},\,\mathbf{X}) \rightarrow \text{attention\_scores}\]

Here, \(\mathbf{X}\) is an input tensor, and attention_scores is the matrix capturing attention weights.

Parameters:

• num_heads (int) – Number of heads for multi-head attention.

• key_dim (int) – Dimensionality of the query/key projections.

Notes

Unlike standard layers that return the transformation output, this layer specifically returns the attention score matrix for interpretability.

call(`inputs`, training=False)

Forward pass that outputs only the attention scores.

get_config()

Returns the configuration for serialization.

from_config(`config`)

Creates a new instance from the given config.

Examples

>>> from fusionlab.nn.components import ExplainableAttention
>>> import tensorflow as tf
>>> # Suppose we have input of shape (batch_size, time_steps, features)
>>> x = tf.random.normal((32, 10, 64))
>>> # Instantiate explainable attention
>>> ea = ExplainableAttention(num_heads=4, key_dim=64)
>>> # Forward pass returns attention scores: (B, num_heads, T, T)
>>> scores = ea(x)

See also

CrossAttention

Another attention variant for cross-sequence contexts.

MultiResolutionAttentionFusion

For fusing features via multi-head attention.

References

[1]

Vaswani, A., Shazeer, N., Parmar, N., Uszkoreit, J., Jones, L., Gomez, A. N., Kaiser, L., & Polosukhin, I. (2017). “Attention is all you need.” In Advances in Neural Information Processing Systems (pp. 5998-6008).

__init__(num_heads, key_dim)

Initialize the ExplainableAttention layer.

Parameters:

• num_heads (int) – Number of attention heads.

• key_dim (int) – Dimensionality of query/key projections in multi-head attention.

Methods

__init__(num_heads, key_dim)	Initialize the ExplainableAttention layer.
add_loss(losses, **kwargs)	Add loss tensor(s), potentially dependent on layer inputs.
add_metric(value[, name])	Adds metric tensor to the layer.
add_update(updates)	Add update op(s), potentially dependent on layer inputs.
add_variable(*args, **kwargs)	Deprecated, do NOT use! Alias for add_weight.
add_weight([name, shape, dtype, ...])	Adds a new variable to the layer.
build(input_shape)	Creates the variables of the layer (for subclass implementers).
build_from_config(config)	Builds the layer's states with the supplied config dict.
call(inputs[, training])	Forward pass that returns only the attention scores.
compute_mask(inputs[, mask])	Computes an output mask tensor.
compute_output_shape(input_shape)	Computes the output shape of the layer.
compute_output_signature(input_signature)	Compute the output tensor signature of the layer based on the inputs.
count_params()	Count the total number of scalars composing the weights.
finalize_state()	Finalizes the layers state after updating layer weights.
from_config(config)	Creates a new instance from the config dictionary.
get_build_config()	Returns a dictionary with the layer's input shape.
get_config()	Returns the layer configuration.
get_input_at(node_index)	Retrieves the input tensor(s) of a layer at a given node.
get_input_mask_at(node_index)	Retrieves the input mask tensor(s) of a layer at a given node.
get_input_shape_at(node_index)	Retrieves the input shape(s) of a layer at a given node.
get_output_at(node_index)	Retrieves the output tensor(s) of a layer at a given node.
get_output_mask_at(node_index)	Retrieves the output mask tensor(s) of a layer at a given node.
get_output_shape_at(node_index)	Retrieves the output shape(s) of a layer at a given node.
get_params([deep])	Get the parameters for this learner.
get_weights()	Returns the current weights of the layer, as NumPy arrays.
help(**kwargs)
load(file_path[, format])	Load the learner's state from a specified file in the desired format.
load_own_variables(store)	Loads the state of the layer.
save([file_path, format, overwrite, ...])	Save the learner's state to a specified file in the desired format.
save_own_variables(store)	Saves the state of the layer.
set_params(**params)	Set the parameters of this learner.
set_weights(weights)	Sets the weights of the layer, from NumPy arrays.
summary()	Provide a summary of the learner's parameters.
with_name_scope(method)	Decorator to automatically enter the module name scope.

Attributes

activity_regularizer	Optional regularizer function for the output of this layer.
compute_dtype	The dtype of the layer's computations.
dtype	The dtype of the layer weights.
dtype_policy	The dtype policy associated with this layer.
dynamic	Whether the layer is dynamic (eager-only); set in the constructor.
inbound_nodes	Return Functional API nodes upstream of this layer.
input	Retrieves the input tensor(s) of a layer.
input_mask	Retrieves the input mask tensor(s) of a layer.
input_shape	Retrieves the input shape(s) of a layer.
input_spec	InputSpec instance(s) describing the input format for this layer.
losses	List of losses added using the add_loss() API.
metrics	List of metrics attached to the layer.
my_params
name	Name of the layer (string), set in the constructor.
name_scope	Returns a tf.name_scope instance for this class.
non_trainable_variables	Sequence of non-trainable variables owned by this module and its submodules.
non_trainable_weights	List of all non-trainable weights tracked by this layer.
outbound_nodes	Return Functional API nodes downstream of this layer.
output	Retrieves the output tensor(s) of a layer.
output_mask	Retrieves the output mask tensor(s) of a layer.
output_shape	Retrieves the output shape(s) of a layer.
stateful
submodules	Sequence of all sub-modules.
supports_masking	Whether this layer supports computing a mask using compute_mask.
trainable
trainable_variables	Sequence of trainable variables owned by this module and its submodules.
trainable_weights	List of all trainable weights tracked by this layer.
updates
variable_dtype	Alias of Layer.dtype, the dtype of the weights.
variables	Returns the list of all layer variables/weights.
weights	Returns the list of all layer variables/weights.

__init__(num_heads, key_dim)

Initialize the ExplainableAttention layer.

Parameters:

• num_heads (int) – Number of attention heads.

• key_dim (int) – Dimensionality of query/key projections in multi-head attention.

call(inputs, training=False)

Forward pass that returns only the attention scores.

Parameters:

• inputs (tf.Tensor) – Tensor of shape (B, T, D).

• training (bool, optional) – Indicates training mode; not used in this layer. Defaults to False.

Returns:

Attention scores of shape (B, num_heads, T, T).

Return type:

tf.Tensor

get_config()

Returns the layer configuration.

Returns:

Dictionary containing ‘num_heads’ and ‘key_dim’.

Return type:

dict

classmethod from_config(config)

Creates a new instance from the config dictionary.

Parameters:

config (dict) – Configuration dictionary.

Returns:

A new instance of this layer.

Return type:

ExplainableAttention

help(**kwargs)

my_params = ExplainableAttention(num_heads, key_dim)