adding SoftMax and SpatialSoftMax bindings

1 files changed, 8 insertions, 3 deletions

diff --git a/README.md b/README.md
index c8f6ff7..01d7ab0 100644
--- a/README.md
+++ b/README.md
@@ -11,12 +11,17 @@ Modules are API compatible their nn equivalents. Fully unit-tested against nn im
 
 ####Modules
 ```
+-- All inputs have to be 4D, even for ReLU, SoftMax etc.
 cudnn.SpatialConvolution(nInputPlane, nOutputPlane, kW, kH, dW, dH, padW, padH)
 cudnn.SpatialMaxPooling(kW, kH, dW, dH)
 cudnn.SpatialAveragePooling(kW, kH, dW, dH)
-cudnn.ReLU()
-cudnn.Tanh()
-cudnn.Sigmoid()
+cudnn.ReLU()            
+cudnn.Tanh()            
+cudnn.Sigmoid()         
+
+-- SoftMax can be run in fast mode or accurate mode. Default is accurate mode.
+cudnn.SoftMax(fastMode [= false])          -- SoftMax across each image (just like nn.SoftMax)
+cudnn.SpatialSoftMax(fastMode [= false])   -- SoftMax across feature-maps (per spatial location)
 ```
 
 I have no time to support these, so please dont expect a quick response to filed github issues.