Skip to content

Commit

Permalink
minor changes in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
atenagm1375 committed Apr 3, 2021
1 parent 9958a38 commit 52c44fb
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions cnsproject/encoding/encoders.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ class AbstractEncoder(ABC):
time : int
Length of encoded tensor.
dt : float, Optional
Simulation timestep. The default is 1.0.
Simulation time step. The default is 1.0.
device : str, Optional
The device to do the comutations. The default is "cpu".
The device to do the computations. The default is "cpu".
"""

Expand Down
3 changes: 1 addition & 2 deletions cnsproject/network/connections.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
import torch

from .neural_populations import NeuralPopulation
# from ..learning.learning_rules import LearningRule, NoOp


class AbstractConnection(ABC, torch.nn.Module):
Expand Down Expand Up @@ -121,7 +120,7 @@ def compute(self, s: torch.Tensor) -> None:
@abstractmethod
def update(self, **kwargs) -> None:
"""
Compute connection's learning rule.
Compute connection's learning rule and weight update.
Keyword Arguments
-----------------
Expand Down
7 changes: 5 additions & 2 deletions cnsproject/network/network.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ def __init__(

self.train(learning)

# Make sure that arguments of your reward and decision classes do not
# share same names. Their arguments are passed to the network as its
# keyword arguments.
self.reward = reward(**kwargs)
self.decision = decision(**kwargs)

Expand Down Expand Up @@ -201,8 +204,8 @@ def run(
Mapping of connection names to boolean masks of the weights to clamp
to zero.
Note: you can pass the reward and decision arguments as keyword\
argumeents to this function.
**Note:** you can pass the reward and decision methods' arguments as keyword\
arguments to this function.
Returns
-------
Expand Down

0 comments on commit 52c44fb

Please sign in to comment.