singa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wang...@apache.org
Subject [09/21] incubator-singa git commit: SINGA-68 Preparation for Release -- License etc.
Date Wed, 16 Sep 2015 04:19:48 GMT
SINGA-68 Preparation for Release -- License etc.

Minor edits on the README file


Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/17914421
Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/17914421
Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/17914421

Branch: refs/heads/tutorial
Commit: 1791442112091814c74a96418c99883ce9a0927b
Parents: 9cded5e
Author: Anh Dinh <ug93tad@gmail.com>
Authored: Tue Sep 15 21:34:01 2015 +0800
Committer: wang sheng <wangsheng1001@gmail.com>
Committed: Wed Sep 16 11:09:25 2015 +0800

----------------------------------------------------------------------
 README    | 20 --------------------
 README.md | 42 +++++++++++++++++++++++-------------------
 2 files changed, 23 insertions(+), 39 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/17914421/README
----------------------------------------------------------------------
diff --git a/README b/README
deleted file mode 100644
index 6ccaac4..0000000
--- a/README
+++ /dev/null
@@ -1,20 +0,0 @@
-TODO
-
-##Apache SINGA
-
-Distributed deep learning system
-
-[Project Website](http://singa.incubator.apache.org)
-
-All the details can be found in project website.
-
-The current code depends on the following external libraries:
-  * glog (New BSD)
-  * google-protobuf (New BSD)
-  * openblas (New BSD)
-  * zeromq (LGPLv3 + static link exception)
-  * czmq (Mozilla Public License Version 2.0)
-  * zookeeper (Apache 2.0)
-  * lmdb (OpenLDAP)
-
-

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/17914421/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 0777c6b..b7d4528 100644
--- a/README.md
+++ b/README.md
@@ -12,43 +12,47 @@ All the details can be found in [Project Website](http://singa.incubator.apache.
 * [Development Mailing List](mailto:dev-subscribe@singa.incubator.apache.org)([Archive](http://mail-archives.apache.org/mod_mbox/singa-dev/))
 * [Commits Mailing List](mailto:commits-subscribe@singa.incubator.apache.org)([Archive](http://mail-archives.apache.org/mod_mbox/singa-commits/))
 
-##Documentation
+##Dependencies
+The current code depends on the following external libraries:
+  * glog (New BSD)
+  * google-protobuf (New BSD)
+  * openblas (New BSD)
+  * zeromq (LGPLv3 + static link exception)
+  * czmq (Mozilla Public License Version 2.0)
+  * zookeeper (Apache 2.0)
+  * lmdb (OpenLDAP)
 
-Documentation is available in [Official Documentation](https://singa.incubator.apache.org/docs/overview.html#).
+##Documentation
 
-##Building SINGA
+Full documentation is available online at [Official Documentation](https://singa.incubator.apache.org/docs/overview.html#).
 
-Just clone our github repo and execute following commands:
 
-	$ git clone git@github.com:apache/incubator-singa.git
-	$ cd incubator-singa
+##Building SINGA
+	
 	$ ./autogen.sh
 	$ ./configure
 	$ make
 
-You can also download the release package from the [Project Website](http://singa.incubator.apache.org)
and follow the instructions on [Official Installation Guide](http://singa.incubator.apache.org/docs/installation.html).
-
-##Running an Example
+##Running Examples
 
-After installation, you may want to run an example to try SINGA.
-Let us train the [CNN model](http://papers.nips.cc/paper/4824-imagenet-classification-with-deep-convolutional-neural-networks)
over the
-[CIFAR-10](http://www.cs.toronto.edu/~kriz/cifar.html) dataset without parallelism as an
instance.
-The hyper-parameters are set following
-[cuda-convnet](https://code.google.com/p/cuda-convnet/). More details about this example
are
-available at [CNN example](http://singa.incubator.apache.org/docs/cnn).
+Let us train the [CNN
+model](http://papers.nips.cc/paper/4824-imagenet-classification-with-deep-convolutional-neural-networks)
over the
+[CIFAR-10](http://www.cs.toronto.edu/~kriz/cifar.html) dataset without parallelism as an
example. The hyper-parameters
+are set following [cuda-convnet](https://code.google.com/p/cuda-convnet/). More details about
this example are available
+at [CNN example](http://singa.incubator.apache.org/docs/cnn).
 
-We firstly download the dataset and create the data shard:
+First, download the dataset and create data shards:
 
 	$ cd examples/cifar10/
 	$ make download
 	$ make create
 
-Then we start training:
+Next, start the training: 
 
 	$ cd ../../
-    $ ./bin/singa-run.sh -conf examples/cifar10/job.conf
+    	$ ./bin/singa-run.sh -conf examples/cifar10/job.conf
 
-Now we just need to wait until it is done! About this part, you can also refer to the [Quick
Start](http://singa.incubator.apache.org/docs/quick-start.html). 
+Now we just need to wait until it is done! 
 
 ##LICENSE
 


Mime
View raw message