Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/clementfarabet/lua---nnx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Leonard <nick@nikopia.org>2014-10-08 19:09:21 +0400
committerNicholas Leonard <nick@nikopia.org>2014-10-08 19:09:21 +0400
commit845196f88f4316ee391504b16693fa0eb27c2a36 (patch)
tree4bb2bc61e16b0a284cb2b06ec76d57be5e0322b5 /README.md
parentffdc1346862aa6e105c9ed02ea7c15d8d1e6f137 (diff)
fixed doc
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 0540ccb..04fd4ce 100644
--- a/README.md
+++ b/README.md
@@ -116,8 +116,8 @@ of each target in the batch. Thus SoftMaxTree requires the targets.
So this Criterion only computes the negative of those outputs, as
well as its corresponding gradients.
-<a name=='nnx.PullTable'/>
-<a name=='nnx.PushTable'/>
+<a name='nnx.PullTable'/>
+<a name='nnx.PushTable'/>
### PushTable (and PullTable) ###
PushTable and PullTable work together. The first can be put earlier
in a digraph of Modules such that it can communicate with a
@@ -183,18 +183,18 @@ In some cases, this can simplify the digraph of Modules. Note that
a PushTable can be associated to many PullTables, but each PullTable
is associated to only one PushTable.
-<a name=='nnx.MultiSoftMax'/>
+<a name='nnx.MultiSoftMax'/>
### MultiSoftMax ###
This Module takes 2D or 3D input and performs a softmax over the last dimension.
It uses the existing [SoftMax](https://github.com/torch/nn/blob/master/doc/transfer.md#nn.SoftMax)
CUDA/C code to do so such that the Module can be used on both GPU and CPU.
This can be useful for [keypoint detection](https://github.com/nicholas-leonard/dp/blob/master/doc/facialkeypointstutorial.md#multisoftmax).
-<a name=='nnx.SpatialReSampling'/>
+<a name='nnx.SpatialReSampling'/>
### SpatialReSampling ###
Applies a 2D re-sampling over an input image composed of
-several input planes (channels/colors). The input tensor in `forward(input)` is
-expected to be a 3D or 4D tensor of size : `[batchSize x] width x height x nInputPlane`.
+several input planes (or channels, colors). The input tensor in `forward(input)` is
+expected to be a 3D or 4D tensor of size : `[batchSize x] nInputPlane x width x height`.
The number of output planes will be the same as the number of input
planes.