You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by wa...@apache.org on 2015/07/23 08:29:32 UTC
svn commit: r1692352 - in /incubator/singa/site/trunk/content/markdown:
docs/cnn.md docs/mlp.md docs/programmer-guide.md quick-start.md
Author: wangwei
Date: Thu Jul 23 06:29:31 2015
New Revision: 1692352
URL: http://svn.apache.org/r1692352
Log:
update mlp and cnn examples using latest command line argument
Modified:
incubator/singa/site/trunk/content/markdown/docs/cnn.md
incubator/singa/site/trunk/content/markdown/docs/mlp.md
incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md
incubator/singa/site/trunk/content/markdown/quick-start.md
Modified: 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=1692352&r1=1692351&r2=1692352&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/cnn.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/cnn.md Thu Jul 23 06:29:31 2015
@@ -19,16 +19,16 @@ Notice: Licensed to the Apache Softwa
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.
+* 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.
+ 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
+* Run the command `./bin/singa-run.sh -workspace=examples/cifar10` 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.
+* 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.
Modified: 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=1692352&r1=1692351&r2=1692352&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/mlp.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/mlp.md Thu Jul 23 06:29:31 2015
@@ -23,19 +23,19 @@ This example will show you how to use SI
### 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).
+ 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
+* Run the command `./bin/singa-run.sh -workspace=examples/mnist`
+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.
+* 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.
Modified: incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md?rev=1692352&r1=1692351&r2=1692352&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md Thu Jul 23 06:29:31 2015
@@ -54,8 +54,7 @@ Each training job has a driver program t
* registers the layers implemented by the user and,
- * starts the [Trainer](https://github.com/apache/incubator-singa/blob/master/include/trainer/trainer.h)
- by providing the job configuration.
+ * submit the job by providing the job configuration.
An example driver program is like
@@ -77,8 +76,7 @@ An example driver program is like
JobProto jobConf;
// read job configuration from text conf file
ReadProtoFromTextFile(&jobConf, FLAGS_workspace + "/job.conf");
- Trainer trainer;
- trainer.Start(FLAGS_job, jobConf, FLAGS_resume);
+ singa::SubmitJob(FLAGS_job, FLAGS_resume, jobConf);
}
Users can also configure the job in the driver program instead of writing the
@@ -88,14 +86,17 @@ configuration file
JobProto jobConf;
jobConf.set_job_name("my singa job");
... // configure cluster and model
- Trainer trainer;
- trainer.Start(FLAGS_job, jobConf, FLAGS_resume);
+ singa::SubmitJob(FLAGS_job, FLAGS_resume, jobConf);
We will provide helper functions to make the configuration easier in the
future, like [keras](https://github.com/fchollet/keras).
Compile and link the driver program with singa library to generate an
-executable, e.g., with name `mysinga`. To submit the job, just pass the path of
+executable file, e.g., with name `mysinga`. To submit the job, just pass the path of
the executable and the workspace to the singa job submission script
./bin/singa-run.sh <path to mysinga> -workspace=<my job workspace>
+
+The default driver (i.e., main.cc) will be complied and linked to generate
+`singa`, which is used as the default executable file (no need to put it in the
+command line)
Modified: incubator/singa/site/trunk/content/markdown/quick-start.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/quick-start.md?rev=1692352&r1=1692351&r2=1692352&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/quick-start.md (original)
+++ incubator/singa/site/trunk/content/markdown/quick-start.md Thu Jul 23 06:29:31 2015
@@ -65,6 +65,8 @@ job configuration file (*job.conf*). If
modules, then you have to register your modules in the [driver
program](user-guide.html).
+#### Start Training
+
Start the training by running:
#goto top level folder