Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
smm-ncl committed Jan 23, 2024
1 parent 77c7a40 commit 6138d59
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions src/lava/proc/s4d/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,16 @@ def __init__(self, proc_params: Dict[str, Any]) -> None:
Sigma delta neuron model that implements S4D
(as described by Gu et al., 2022) dynamics as its activation function.
Parameters
----------
shape: Tuple
Shape of the sigma process.
vth: int or float
Threshold of the delta encoder.
Relevant parameters in proc_params
--------------------------
a: np.ndarray
Diagonal elements of the state matrix of the S4D model.
b: np.ndarray
Diagonal elements of the input matrix of the S4D model.
c: np.ndarray
Diagonal elements of the output matrix of the S4D model.
state_exp: int
Scaling exponent with base 2 for the reconstructed sigma variables.
Note: This should only be used for nc models.
Default is 0.
s4_exp: int
Scaling exponent with base 2 for the S4 state variables.
Note: This should only be used for nc models.
Default is 0.
s4_state: np.ndarray
State vector of the S4D model.
"""
super().__init__(proc_params)
self.a = self.proc_params['a']
Expand Down

0 comments on commit 6138d59

Please sign in to comment.