selfloop_cycle

selfloop_cycle([rng], [T], dims...;
    cycle_weight=0.1, selfloop_weight=0.1,
    radius=nothing, return_sparse=false, kwargs...)

Creates a simple cycle reservoir with the addition of self loops (Elsarraj et al., 2019).

This architecture is referred to as TP1 in the original paper.

\[W_{i,j} = \begin{cases} ll, & \text{if } i = j \\ r, & \text{if } j = i - 1 \text{ for } i = 2 \dots N \\ r, & \text{if } i = 1, j = N \\ 0, & \text{otherwise} \end{cases}\]

Arguments

• rng: Random number generator. Default is Utils.default_rng()from WeightInitializers.
• T: Type of the elements in the reservoir matrix. Default is Float32.
• dims: Dimensions of the reservoir matrix.

Keyword arguments

• cycle_weight: Weight of the cycle connections in the reservoir matrix. This can be provided as a single value or an array. In case it is provided as an array please make sure that the length of the array matches the length of the cycle you want to populate. Default is 0.1.

• selfloop_weight: Weight of the self loops in the reservoir matrix. This can be provided as a single value or an array. In case it is provided as an array please make sure that the length of the array matches the length of the diagonal you want to populate. Default is 0.1.

• radius: The desired spectral radius of the reservoir. If nothing is passed, no scaling takes place. Defaults to nothing.

• return_sparse: flag for returning a sparse matrix. true requires SparseArrays to be loaded. Default is false.

• cycle_kwargs and jump_kwargs: named tuples that control the kwargs for the cycle and jump weights respectively. The kwargs are as follows:

  • signs: Controls sign flips. Use RandomSigns, RegularSigns, or IrrationalDigitSigns. Pass nothing to leave signs unchanged. Default is nothing.

Examples

Default call:

julia> res_matrix = selfloop_cycle(5, 5)
5×5 Matrix{Float32}:
 0.1  0.0  0.0  0.0  0.1
 0.1  0.1  0.0  0.0  0.0
 0.0  0.1  0.1  0.0  0.0
 0.0  0.0  0.1  0.1  0.0
 0.0  0.0  0.0  0.1  0.1

jldoctest slcycle

Changing weights:

julia> res_matrix = selfloop_cycle(5, 5; cycle_weight=-0.2, selfloop_weight=0.5)
5×5 Matrix{Float32}:
  0.5   0.0   0.0   0.0  -0.2
 -0.2   0.5   0.0   0.0   0.0
  0.0  -0.2   0.5   0.0   0.0
  0.0   0.0  -0.2   0.5   0.0
  0.0   0.0   0.0  -0.2   0.5

Changing weights to custom arrays:

julia> cycle_weights = Float32[0.2, 0.4, 0.6, 0.8, 1.0];

julia> selfloop_weights = -Float32[0.1, 0.3, 0.5, 0.7, 0.9];

julia> res_matrix = selfloop_cycle(5, 5;
           cycle_weight = cycle_weights, selfloop_weight = selfloop_weights);

julia> diag(res_matrix) == selfloop_weights && count(!iszero, res_matrix) == 10
true

Changing sign of the weights with different sign patterns:

julia> res_matrix = selfloop_cycle(5, 5; cycle_kwargs=(;signs = IrrationalDigitSigns()))
5×5 Matrix{Float32}:
  0.1  0.0   0.0   0.0  -0.1
 -0.1  0.1   0.0   0.0   0.0
  0.0  0.1   0.1   0.0   0.0
  0.0  0.0  -0.1   0.1   0.0
  0.0  0.0   0.0  -0.1   0.1

julia> res_matrix = selfloop_cycle(5, 5; selfloop_kwargs=(;signs = RandomSigns()))
5×5 Matrix{Float32}:
 0.1   0.0  0.0   0.0  0.1
 0.1  -0.1  0.0   0.0  0.0
 0.0   0.1  0.1   0.0  0.0
 0.0   0.0  0.1  -0.1  0.0
 0.0   0.0  0.0   0.1  0.1

Returning as sparse:

julia> using SparseArrays

julia> res_matrix = selfloop_cycle(5, 5; return_sparse=true)
5×5 SparseMatrixCSC{Float32, Int64} with 10 stored entries:
 0.1   ⋅    ⋅    ⋅   0.1
 0.1  0.1   ⋅    ⋅    ⋅
  ⋅   0.1  0.1   ⋅    ⋅
  ⋅    ⋅   0.1  0.1   ⋅
  ⋅    ⋅    ⋅   0.1  0.1