Mailing-List: contact commits-help@singa.incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@singa.incubator.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1691206 -
 /incubator/singa/site/trunk/content/markdown/docs/cnn.md
Date: Wed, 15 Jul 2015 13:25:11 -0000
To: commits@singa.incubator.apache.org
From: jinyang@apache.org
Message-Id: <20150715132511.DFB63AC0553@hades.apache.org>

Author: jinyang
Date: Wed Jul 15 13:25:11 2015
New Revision: 1691206

URL: http://svn.apache.org/r1691206
Log:
cnn

Added:
    incubator/singa/site/trunk/content/markdown/docs/cnn.md

Added: incubator/singa/site/trunk/content/markdown/docs/cnn.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/docs/cnn.md?rev=1691206&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/cnn.md (added)
+++ incubator/singa/site/trunk/content/markdown/docs/cnn.md Wed Jul 15 13:25:11 2015
@@ -0,0 +1,34 @@
+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 CNN model using cifar10 dataset.
+
+### Prepare for the data
+* Run the command `make download` and `make create`  in the folder `example/cifar10/` to download cifar10 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 CNN model that contains 3 convolution+relu+maxpooling+normalization layers. 
+
+### Run SINGA
+* Run the command `./bin/singa-run.sh -model=examples/cifar10/model.conf -cluster=examples/cifar10/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.