Author: jinyang
Date: Wed Jul 15 13:23:38 2015
New Revision: 1691205
URL: http://svn.apache.org/r1691205
Log:
mlp example
Added:
incubator/singa/site/trunk/content/markdown/docs/mlp.md
Added: incubator/singa/site/trunk/content/markdown/docs/mlp.md
URL:
http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/docs/mlp.md?rev=1691205&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/mlp.md (added)
+++ incubator/singa/site/trunk/content/markdown/docs/mlp.md Wed Jul 15 13:23:38
2015
@@ -0,0 +1,41 @@
+Title:
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+This example will show you how to use SINGA to train a MLP model using mnist
dataset.
+
+### Prepare for the data
+* Run the command `make download` and `make create` in the folder
`example/mnist/` to download mnist dataset and prepare for the training and
testing datashard. If you got the error no Makefile detected, rename
Makefile.example to Makefile.
+
+### Set model and cluster configuration.
+* If you just want to use the training model provided in this example, you can
just use model.conf file in current directory.
+ In this example, we define a neurualnet that contains 5 hidden layer.
+fc+tanh is the hidden layer(fc is for the inner product part, and tanh is for
the non-linear activation function),
+and the final softmax layer is represented as fc+loss (inner product and
softmax).
+For each layer, we define its name, input layer(s), basic configurations (e.g.
number of nodes, parameter initialization settings).
+
+### Run SINGA
+* Run the command `./bin/singa-run.sh -model=examples/mnist/model.conf
-cluster=examples/mnist/cluster.conf`
+in the root folder of SINGA
+
+
+### Build your own model
+* If you want to specify you own model, then you need to decribe it in the
model.conf file.
+It should contain the neurualnet structure, training algorithm(backforward or
contrastive divergence etc.),
+SGD update algorithm(e.g. Adagrad), number of training/test steps and
training/test frequency,
+and display features and etc. SINGA will read model.conf as a Google protobuf
class
[ModelProto](https://github.com/apache/incubator-singa/blob/master/src/proto/model.proto).
+You can also refer to the [programming
model](http://singa.incubator.apache.org/docs/programming-model.html) to get
details.
