singa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wang...@apache.org
Subject svn commit: r1692811 - in /incubator/singa/site/trunk/content: markdown/docs/checkpoint.md markdown/docs/debug.md markdown/docs/model-config.md markdown/docs/programmer-guide.md site.xml
Date Mon, 27 Jul 2015 05:52:59 GMT
Author: wangwei
Date: Mon Jul 27 05:52:58 2015
New Revision: 1692811

URL: http://svn.apache.org/r1692811
Log:
add debug doc;

Added:
    incubator/singa/site/trunk/content/markdown/docs/debug.md
Modified:
    incubator/singa/site/trunk/content/markdown/docs/checkpoint.md
    incubator/singa/site/trunk/content/markdown/docs/model-config.md
    incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md
    incubator/singa/site/trunk/content/site.xml

Modified: incubator/singa/site/trunk/content/markdown/docs/checkpoint.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/docs/checkpoint.md?rev=1692811&r1=1692810&r2=1692811&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/checkpoint.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/checkpoint.md Mon Jul 27 05:52:58 2015
@@ -49,7 +49,7 @@ job.conf of the new model as:
 
     model {
       ...
-      checkpoint : WORKSPACE/checkpoint/step400-worker0.bin
+      checkpoint : "WORKSPACE/checkpoint/step400-worker0.bin"
       ...
     }
 
@@ -58,8 +58,8 @@ partitioning, all the checkpoint files s
 
     model {
       ...
-      checkpoint : WORKSPACE/checkpoint/step400-worker0.bin
-      checkpoint : WORKSPACE/checkpoint/step400-worker1.bin
+      checkpoint : "WORKSPACE/checkpoint/step400-worker0.bin"
+      checkpoint : "WORKSPACE/checkpoint/step400-worker1.bin"
       ...
     }
 

Added: incubator/singa/site/trunk/content/markdown/docs/debug.md
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/markdown/docs/debug.md?rev=1692811&view=auto
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/debug.md (added)
+++ incubator/singa/site/trunk/content/markdown/docs/debug.md Mon Jul 27 05:52:58 2015
@@ -0,0 +1,31 @@
+## How to Debug
+
+___
+
+### Compile with -g
+
+Since SINGA is developed on Linux using C++, GDB is the preferred debugging
+tool. To use GDB, the code must be compiled with `-g` flag. The files (e.g.,
+Makefile.am) from GNU compilation tool are not easy to change. Hence SINGA
+comes with a Makefile.example for developers. To compile the code for
+debugging, just
+
+    cp Makefile.example  Makefile
+    #change -O3 to -g for the CXXFLAGS
+    make
+
+To debug, first start zookeeper if it is not started yet, and launch GDB
+
+    # do this for only once
+    ./bin/zk-service.sh start
+    # do this every time
+    gdb singa
+
+Then set the command line arguments
+
+    set args -workspace=WORKSPACE -job=JOBID
+
+The JOBID is an unsigned integer that has not been used before. WORKSPACE must
+include a file with name `job.conf`.
+
+Now you can set your breakpoints and start running.

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=1692811&r1=1692810&r2=1692811&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/model-config.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/model-config.md Mon Jul 27 05:52:58 2015
@@ -302,5 +302,5 @@ listed:
     // checkpoint path
     optional bool resume = 36 [default = false];
 
-The pages of [checkpoint and restore](), [validation and test]() have more details
+The pages of [checkpoint and restore](checkpoint.html), [validation and test]() have more
details
 on 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=1692811&r1=1692810&r2=1692811&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md (original)
+++ incubator/singa/site/trunk/content/markdown/docs/programmer-guide.md Mon Jul 27 05:52:58
2015
@@ -1,6 +1,8 @@
-## Programming Model
+## Programmer Guide
 
-We describe the programming model of SINGA to provide users instructions of
+___
+
+This guide provides instructions of
 implementing a new model and submitting the training job. The programming model
 is made almost transparent to the underlying distributed environment. Hence
 users do not need to worry much about the communication and synchronization of
@@ -9,7 +11,7 @@ nodes, which is discussed in [architectu
 ### Deep learning training
 
 Deep learning is labeled as a feature learning technique, which usually
-consists of multiple layers.  Each layer is associated a feature transformation
+consists of multiple layers.  Each layer is associated with a feature transformation
 function. After going through all layers, the raw input feature (e.g., pixels
 of images) would be converted into a high-level feature that is easier for
 tasks like classification.

Modified: incubator/singa/site/trunk/content/site.xml
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/content/site.xml?rev=1692811&r1=1692810&r2=1692811&view=diff
==============================================================================
--- incubator/singa/site/trunk/content/site.xml (original)
+++ incubator/singa/site/trunk/content/site.xml Mon Jul 27 05:52:58 2015
@@ -59,12 +59,14 @@
         <item name ="Model Configuration" href="docs/model-config.html"/>
         <item name="Neural Network" href="docs/neuralnet.html"/>
         <item name="Layer" href="docs/layer.html"/>
+        <item name="Param" href="docs/param.html"/>
       </item>
       <item name = "Data Preparation" href = "docs/data.html"/>
       <item name = "Checkpoint" href = "docs/checkpoint.html"/>
       <item name="System Architecture" href="docs/architecture.html"/>
       <item name="Communication" href="docs/communication.html"/>
       <item name="Examples" href="docs/examples.html"/>
+      <item name="Debug" href="docs/debug.html"/>
     </menu>
 
     <menu name="Development">



Mime
View raw message