diff options
author | Ivo Danihelka <ivo@danihelka.net> | 2013-02-23 16:49:46 +0400 |
---|---|---|
committer | Ivo Danihelka <ivo@danihelka.net> | 2013-02-23 16:49:46 +0400 |
commit | ac1c07ed6cad8a8b99340fbd97e16c1a87e0e5f7 (patch) | |
tree | 178149de791b95453a85321519cac686ee63f86c | |
parent | f328917848bf4b05a097445414210e7f9d1effdc (diff) |
Corrected getParameters() documentation.
-rw-r--r-- | dok/index.dok | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/dok/index.dok b/dok/index.dok index be2d20d..9d720a5 100644 --- a/dok/index.dok +++ b/dok/index.dok @@ -415,14 +415,14 @@ wrt to the learnable parameters ''{gradWeights}''. Custom modules should override this function if they use learnable parameters that are stored in tensors. -==== [{flatParameters}, {flatGradParameters}] getParameters() ==== +==== [flatParameters, flatGradParameters] getParameters() ==== {{anchor:nn.Module.getParameters}} -This function should returns two tables. One for the flattened learnable -parameters ''{flatParameters}'' and another for the gradients of the energy -wrt to the learnable parameters ''{flatGradParameters}''. +This function returns two tensors. One for the flattened learnable +parameters ''flatParameters'' and another for the gradients of the energy +wrt to the learnable parameters ''flatGradParameters''. -Custom moduels should not override this function. They should instead override [[#nn.Module.getParameters|parameters(...)]] which is, in turn, called by the present function. +Custom moduels should not override this function. They should instead override [[#nn.Module.parameters|parameters(...)]] which is, in turn, called by the present function. ===== Containers ===== {{anchor:nn.Containers}} |