Skip to content

Commit 8b48393

Browse files
refactor: formatting
1 parent 69524fd commit 8b48393

File tree

2 files changed

+29
-25
lines changed

2 files changed

+29
-25
lines changed

src/esn/esn_inits.jl

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -666,23 +666,25 @@ Creates a matrix with backward connections as described in [^rodan2010].
666666
667667
- `weight`: The weight determines the absolute value of
668668
forward connections in the reservoir. Default is 0.1
669+
669670
- `fb_weight`: Determines the absolute value of backward connections
670671
in the reservoir. Default is 0.2
671672
- `return_sparse`: flag for returning a `sparse` matrix.
672673
Default is `false`.
673-
- `delay_kwargs` and `fb_kwargs`: named tuples that control the kwargs for the
674+
- `delay_kwargs` and `fb_kwargs`: named tuples that control the kwargs for the
674675
delay line weight and feedback weights respectively. The kwargs are as follows:
675-
+ `sampling_type`: Sampling that decides the distribution of `weight` negative numbers.
676-
If set to `:no_sample` the sign is unchanged. If set to `:bernoulli_sample!` then each
677-
`weight` can be positive with a probability set by `positive_prob`. If set to
678-
`:irrational_sample!` the `weight` is negative if the decimal number of the
679-
irrational number chosen is odd. Default is `:no_sample`.
680-
+ `positive_prob`: probability of the `weight` being positive when `sampling_type` is
681-
set to `:bernoulli_sample!`. Default is 0.5
682-
+ `irrational`: Irrational number whose decimals decide the sign of `weight`.
683-
Default is `pi`.
684-
+ `start`: Which place after the decimal point the counting starts for the `irrational`
685-
sign counting. Default is 1.
676+
677+
+ `sampling_type`: Sampling that decides the distribution of `weight` negative numbers.
678+
If set to `:no_sample` the sign is unchanged. If set to `:bernoulli_sample!` then each
679+
`weight` can be positive with a probability set by `positive_prob`. If set to
680+
`:irrational_sample!` the `weight` is negative if the decimal number of the
681+
irrational number chosen is odd. Default is `:no_sample`.
682+
+ `positive_prob`: probability of the `weight` being positive when `sampling_type` is
683+
set to `:bernoulli_sample!`. Default is 0.5
684+
+ `irrational`: Irrational number whose decimals decide the sign of `weight`.
685+
Default is `pi`.
686+
+ `start`: Which place after the decimal point the counting starts for the `irrational`
687+
sign counting. Default is 1.
686688
687689
# Examples
688690
@@ -738,25 +740,27 @@ Create a cycle jumps reservoir [^Rodan2012].
738740
739741
- `cycle_weight`: The weight of cycle connections.
740742
Default is 0.1.
743+
741744
- `jump_weight`: The weight of jump connections.
742745
Default is 0.1.
743746
- `jump_size`: The number of steps between jump connections.
744747
Default is 3.
745748
- `return_sparse`: flag for returning a `sparse` matrix.
746749
Default is `false`.
747-
- `cycle_kwargs` and `jump_kwargs`: named tuples that control the kwargs for the
750+
- `cycle_kwargs` and `jump_kwargs`: named tuples that control the kwargs for the
748751
cycle and jump weights respectively. The kwargs are as follows:
749-
+ `sampling_type`: Sampling that decides the distribution of `weight` negative numbers.
750-
If set to `:no_sample` the sign is unchanged. If set to `:bernoulli_sample!` then each
751-
`weight` can be positive with a probability set by `positive_prob`. If set to
752-
`:irrational_sample!` the `weight` is negative if the decimal number of the
753-
irrational number chosen is odd. Default is `:no_sample`.
754-
+ `positive_prob`: probability of the `weight` being positive when `sampling_type` is
755-
set to `:bernoulli_sample!`. Default is 0.5
756-
+ `irrational`: Irrational number whose decimals decide the sign of `weight`.
757-
Default is `pi`.
758-
+ `start`: Which place after the decimal point the counting starts for the `irrational`
759-
sign counting. Default is 1.
752+
753+
+ `sampling_type`: Sampling that decides the distribution of `weight` negative numbers.
754+
If set to `:no_sample` the sign is unchanged. If set to `:bernoulli_sample!` then each
755+
`weight` can be positive with a probability set by `positive_prob`. If set to
756+
`:irrational_sample!` the `weight` is negative if the decimal number of the
757+
irrational number chosen is odd. Default is `:no_sample`.
758+
+ `positive_prob`: probability of the `weight` being positive when `sampling_type` is
759+
set to `:bernoulli_sample!`. Default is 0.5
760+
+ `irrational`: Irrational number whose decimals decide the sign of `weight`.
761+
Default is `pi`.
762+
+ `start`: Which place after the decimal point the counting starts for the `irrational`
763+
sign counting. Default is 1.
760764
761765
# Examples
762766

src/esn/inits_components.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ Adds jumps to a given `reservoir_matrix` with chosen `weight` and determined `ju
404404
- `start`: Which place after the decimal point the counting starts for the `irrational`
405405
sign counting. Default is 1.
406406
407-
# Examples
407+
# Examples
408408
409409
```jldoctest
410410
julia> matrix = zeros(Float32, 5, 5)

0 commit comments

Comments
 (0)