singa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wang...@apache.org
Subject svn commit: r1708294 - in /incubator/singa/site/trunk/content/markdown/docs: cnn.md installation.md mlp.md model-config.md programmer-guide.md
Date Tue, 13 Oct 2015 07:20:08 GMT
Author: wangwei
Date: Tue Oct 13 07:20:07 2015
New Revision: 1708294

URL: http://svn.apache.org/viewvc?rev=1708294&view=rev
Log:
update model config page to include test page; add descriptions for test_steps in job configuration;

Modified:
    incubator/singa/site/trunk/content/markdown/docs/cnn.md
    incubator/singa/site/trunk/content/markdown/docs/installation.md
    incubator/singa/site/trunk/content/markdown/docs/mlp.md
    incubator/singa/site/trunk/content/markdown/docs/model-config.md
    incubator/singa/site/trunk/content/markdown/docs/programmer-guide.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=1708294&r1=1708293&r2=1708294&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/cnn.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/cnn.md Tue Oct 13 07:20:07 2015
@@ -77,8 +77,7 @@ and [layer page](layer.html) to write th
 <strong>Figure 1 - Net structure of the CNN example.</strong></img>
 </div>
 
-* We configure a [data layer](layer.html#data-layers) to read
-the training/testing `Records` from `DataShard`.
+* We configure an input layer to read the training/testing records from a disk file.
 
         layer{
           name: "data"

Modified: incubator/singa/site/trunk/content/markdown/docs/installation.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/docs/installation.md?rev=1708294&r1=1708293&r2=1708294&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/installation.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/installation.md Tue Oct 13 07:20:07 2015
@@ -28,7 +28,9 @@ Optional dependencies include:
 
 You can install all dependencies into $PREFIX folder by
 
-    ./thirdparty/install.sh all $PREFIX
+    # make sure you are in the thirdparty folder
+    cd thirdparty
+    ./install.sh all $PREFIX
 
 If $PREFIX is not a system path (e.g., /usr/local/), please export the following
 variables to continue the building instructions,
@@ -95,7 +97,7 @@ to be updated after zhongle changes the
     ./install.sh libname \-\-prefix=
 
 -->
-
+    # must goto thirdparty folder
     $ cd thirdparty
     $ ./install.sh LIB_NAME PREFIX
 

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=1708294&r1=1708293&r2=1708294&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/mlp.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/mlp.md Tue Oct 13 07:20:07 2015
@@ -53,7 +53,6 @@ finished, SINGA will [checkpoint](checkp
 
 ## Details
 
-
 To train a model in SINGA, you need to prepare the datasets,
 and a job configuration which specifies the neural net structure, training
 algorithm (BP or CD), SGD update algorithm (e.g. Adagrad),
@@ -63,7 +62,7 @@ number of training/test steps, etc.
 
 Before using SINGA, you need to write a program to pre-process the dataset you
 use to a format that SINGA can read. Please refer to the
-[Data Preparation](data.html#example---mnist-dataset) to get details about preparing
+[Data Preparation](data.html) to get details about preparing
 this MNIST dataset.
 
 
@@ -84,8 +83,7 @@ stages in total. They sizes of the [Inne
 Next we follow the guide in [neural net page](neural-net.html)
 and [layer page](layer.html) to write the neural net configuration.
 
-* We configure a [data layer](layer.html#data-layers) to read
-the training/testing `Records` from `DataShard`.
+* We configure an input layer to read the training/testing records from a disk file.
 
         layer {
             name: "data"
@@ -115,7 +113,7 @@ the training/testing `Records` from `Dat
              }
              exclude: kTrain
           }
-          
+
 
 * All [InnerProductLayer](layer.html#innerproductlayer)s are configured similarly as,
 

Modified: incubator/singa/site/trunk/content/markdown/docs/model-config.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/docs/model-config.md?rev=1708294&r1=1708293&r2=1708294&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/model-config.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/model-config.md Tue Oct 13 07:20:07 2015
@@ -116,23 +116,18 @@ To configure the model structure, we jus
 A sample configuration for a feed-forward model is like
 
     layer {
-      name : "data"
-      type : kDataShard
-    }
-    layer {
-      name : "image"
-      type : kImageParser
-      srclayers : "data"
+      name : "input"
+      type : kRecordInput
     }
     layer {
       name : "conv"
-      type : kConvolution
-      srclayers : "image"
+      type : kInnerProduct
+      srclayers : "input"
       param {
         // configuration for parameter
       }
-      conv_conf {
-        // configuration for convolution operations
+      innerproduct_conf {
+        // configuration for this specific layer
       }
       ...
     }
@@ -140,17 +135,7 @@ A sample configuration for a feed-forwar
 The layer type list is defined in
 [LayerType](https://github.com/apache/incubator-singa/blob/master/src/proto/model.proto).
 One type (kFoo) corresponds to one child class of Layer (FooLayer) and one
-configuration field (foo_conf). SINGA will infer the dstlayers_ of each layer
-after reading the configuration for all layers. Developers can implement new
-layers and update the type list, then users can use the layer. [Layer
-abstraction]() describes the configurations of current built-in layers.
-
-Fig. 4 shows the model structure corresponding to the neural network
-configuration for the [deep convolutional
-model](https://github.com/apache/incubator-singa/blob/master/examples/cifar10/model.conf).
-
-<img src="../images/dcnn-cifar10.png" style = "width: 200px"> Fig. 4: Neural
-network structure for the example DCNN model (cifar10)</img>
+configuration field (foo_conf). All built-in layers are introduced in the [layer page](layer.html).
 
 ## Worker
 
@@ -293,16 +278,17 @@ Some other important configuration field
 listed:
 
     // model name, e.g., "cifar10-dcnn", "mnist-mlp"
-    required string name = 1;
-    // frequency of displaying training info
-    required int32 display_frequency = 3 ;
-    // total num of steps for training
-    required int32 train_steps = 5;
-    ... // step, frequency for validation and test
-    // frequency of checkpoint
-    optional int32 checkpoint_frequency = 34 [default = 0];
-    // checkpoint path
-    optional bool resume = 36 [default = false];
+    string name;
+    // displaying training info for every this number of iterations, default is 0
+    int32 display_freq;
+    // total num of steps/iterations for training
+    int32 train_steps;
+    // do test for every this number of training iterations, default is 0
+    int32 test_freq;
+    // run test for this number of steps/iterations, default is 0.
+    // The test dataset has test_steps * batchsize instances.
+    int32 test_steps;
+    // do checkpoint for every this number of training steps, default is 0
+    int32 checkpoint_freq;
 
-The pages of [checkpoint and restore](checkpoint.html) has more details
-on related fields.
+The pages of [checkpoint and restore](checkpoint.html) has details on checkpoint related
fields.

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=1708294&r1=1708293&r2=1708294&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md Tue Oct 13 07:20:07
2015
@@ -27,10 +27,12 @@ Users can use the default main function
 job. For this case, a job configuration file written as a google protocol
 buffer message for the [JobProto](../api/classsinga_1_1JobProto.html) must be provided in
the command line,
 
-    ./bin/singa-run.sh -conf <path to job conf> [-resume]
+    ./bin/singa-run.sh -conf <path to job conf> [-resume] [-test]
+
+* `-resume` is for continuing the training from last [checkpoint](checkpoint.html).
+* `-test` is for testing the performance of previously trained model and extracting features
for new data,
+more details are available [here](test.html).
 
-`-resume` is for continuing the training from last
-[checkpoint](checkpoint.html).
 The [MLP](mlp.html) and [CNN](cnn.html)
 examples use built-in components. Please read the corresponding pages for their
 job configuration files. The subsequent pages will illustrate the details on



Mime
View raw message