LinearDirect¶

class LinearDirect(shape: tuple[int, ...] | int, step_time: float, *, synapse: SynapseConstructor, bias: bool = False, delay: float | None = None, batch_size: int = 1, weight_init: OneToOne[Tensor] | None = None, bias_init: OneToOne[Tensor] | None = None, delay_init: OneToOne[Tensor] | None = None)[source]¶

Bases: WeightBiasDelayMixin, Connection

Linear one-to-one connection.

\[y = x \odot W + b\]

Parameters:

shape (tuple[int, ...] | int) – expected shape of input and output tensors, excluding batch dimension.
step_time (float) – length of a simulation time step, in \(\text{ms}\).
synapse (SynapseConstructor) – partial constructor for inner Synapse.
bias (bool, optional) – if the connection should support learnable additive bias. Defaults to False.
delay (float | None, optional) – maximum supported delay length, in \(\text{ms}\), excludes delays when None. Defaults to None.
batch_size (int, optional) – size of input batches for simulation. Defaults to 1.
weight_init (OneToOne[torch.Tensor] | None, optional) – initializer for weights. Defaults to None.
bias_init (OneToOne[torch.Tensor] | None, optional) – initializer for biases. Defaults to None.
delay_init (OneToOne[torch.Tensor] | None, optional) – initializer for delays. Defaults to None.

Shape

LinearDirect.weight, LinearDirect.delay, and LinearDirect.bias:

\(\prod(N_0, \ldots)\)

Where:

\(N_0, \ldots\) are the unbatched input/output dimensions.

Note

When delay is None, no delay_ parameter is created and altering the maximum delay of synapse will have no effect. Setting to 0 will create and register a delay_ parameter but not use delays unless it is later changed.

Note

If weight_init or bias_init are None, weight and bias are, respectively, initialized as uniform random values over the interval \([0, 1)\) using torch.rand().

If delay_init is None, delay is initialized as zeros using torch.rand().

forward(*inputs: Tensor, **kwargs) → Tensor[source]¶

Generates connection output from inputs, after passing through the synapse.

Outputs are determined as the learned linear transformation applied to synaptic currents, after new input is applied to the synapse, then reshaped to match batched_outshape.

Parameters:: inputs (torch.Tensor) – inputs to the connection.
Returns:: outputs from the connection.
Return type:: torch.Tensor

Shape

*inputs:

\(B \times N_0 \times \cdots\)

return:

\(B \times N_0 \times \cdots\)

Where:

\(B\) is the batch size.
\(N_0, \ldots\) are the unbatched input/output dimensions.

Note

*inputs are reshaped using like_synaptic() then passed to py:meth:~Synapse.forward of synapse. Keyword arguments are also passed through.

property inshape: tuple[int, ...]¶

Shape of inputs to the connection, excluding the batch dimension.

Returns:: shape of inputs to the connection.
Return type:: tuple[int]

like_bias(data: Tensor) → Tensor[source]¶

Reshapes data like reduced postsynaptic receptive spikes to connection bias.

Parameters:: data (torch.Tensor) – data shaped like reduced postsynaptic receptive spikes.
Returns:: reshaped data.
Return type:: torch.Tensor

Shape

data:

\(N\)

return:

\(N\)

Where:

\(N\) is the number of elements across input/output dimensions.

like_input(data: Tensor) → Tensor[source]¶

Reshapes data like synapse input to connection input.

Parameters:: data (torch.Tensor) – data shaped like synapse input.
Returns:: reshaped data.
Return type:: torch.Tensor

Shape

data:

\(B \times N\)

return:

\(B \times N_0 \times \cdots\)

Where:

\(B\) is the batch size.
\(N\) is the number of elements across input/output dimensions.
\(N_0, \ldots\) are the unbatched input/output dimensions.

like_synaptic(data: Tensor) → Tensor[source]¶

Reshapes data like connection input to synapse input.

Parameters:: data (torch.Tensor) – data shaped like connection input.
Returns:: reshaped data.
Return type:: torch.Tensor

Shape

data:

\(B \times N_0 \times \cdots\)

return:

\(B \times N\)

Where:

\(B\) is the batch size.
\(N_0, \ldots\) are the unbatched input/output dimensions.
\(N\) is the number of elements across input/output dimensions.

property outshape: tuple[int, ...]¶

Shape of outputs from the connection, excluding the batch dimension.

Returns:: shape of outputs from the connection.
Return type:: tuple[int]

postsyn_receptive(data: Tensor) → Tensor[source]¶

Reshapes data like connection output for pre-post learning methods.

Parameters:: data (torch.Tensor) – data shaped like output of forward().
Returns:: reshaped data.
Return type:: torch.Tensor

Shape

data:

\(B \times N_0 \times \cdots\)

return:

\(B \times N \times 1\)

Where:

\(B\) is the batch size.
\(N_0, \ldots\) are the unbatched input/output dimensions.
\(N\) is the number of elements across input/output dimensions.

presyn_receptive(data: Tensor) → Tensor[source]¶

Reshapes data like the synapse state for pre-post learning methods.

Parameters:: data (torch.Tensor) – data shaped like output of like_synaptic().
Returns:: reshaped data.
Return type:: torch.Tensor

Shape

data:

\(B \times N \times [1]\)

return:

\(B \times N \times 1\)

Where:

\(B\) is the batch size.
\(N\) is the number of elements across output dimensions.

property selector: Tensor | None¶

Learned delays as a selector for synaptic currents and delays.

Returns:: delay selector if the connection has learnable delays.
Return type:: torch.Tensor | None

Shape

\(1 \times N \times 1\)

Where:

\(N\) is the number of elements across input/output dimensions.