Return-Path: X-Original-To: apmail-singa-commits-archive@minotaur.apache.org Delivered-To: apmail-singa-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 64A2D188AF for ; Mon, 27 Jul 2015 05:53:17 +0000 (UTC) Received: (qmail 26293 invoked by uid 500); 27 Jul 2015 05:53:17 -0000 Delivered-To: apmail-singa-commits-archive@singa.apache.org Received: (qmail 26276 invoked by uid 500); 27 Jul 2015 05:53:17 -0000 Mailing-List: contact commits-help@singa.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@singa.incubator.apache.org Delivered-To: mailing list commits@singa.incubator.apache.org Received: (qmail 26267 invoked by uid 99); 27 Jul 2015 05:53:17 -0000 Received: from Unknown (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 27 Jul 2015 05:53:17 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id D853F1907D9 for ; Mon, 27 Jul 2015 05:53:16 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 1.791 X-Spam-Level: * X-Spam-Status: No, score=1.791 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, T_RP_MATCHES_RCVD=-0.01, URIBL_BLOCKED=0.001] autolearn=disabled Received: from mx1-eu-west.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id GXWOK8CtBJhi for ; Mon, 27 Jul 2015 05:53:02 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-eu-west.apache.org (ASF Mail Server at mx1-eu-west.apache.org) with SMTP id 95B7C334DC for ; Mon, 27 Jul 2015 05:53:01 +0000 (UTC) Received: (qmail 25567 invoked by uid 99); 27 Jul 2015 05:53:00 -0000 Received: from eris.apache.org (HELO hades.apache.org) (140.211.11.105) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 27 Jul 2015 05:53:00 +0000 Received: from hades.apache.org (localhost [127.0.0.1]) by hades.apache.org (ASF Mail Server at hades.apache.org) with ESMTP id 30E81AC0024 for ; Mon, 27 Jul 2015 05:53:00 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit 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 -0000 To: commits@singa.incubator.apache.org From: wangwei@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150727055300.30E81AC0024@hades.apache.org> 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 @@ + +