You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by zh...@apache.org on 2017/01/09 04:10:22 UTC
[7/7] incubator-singa git commit: update README.md of the repo.
update the docs for debian pacakge fix a bug in build.sh (the sed command)
fix the notebook link
update README.md of the repo.
update the docs for debian pacakge
fix a bug in build.sh (the sed command)
fix the notebook link
Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/a3446b5c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/a3446b5c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/a3446b5c
Branch: refs/heads/master
Commit: a3446b5cdbdacda7b531d231dfb7b917265ed347
Parents: 771d0ee
Author: wangwei <wa...@comp.nus.edu.sg>
Authored: Sat Jan 7 22:56:46 2017 +0800
Committer: wangwei <wa...@comp.nus.edu.sg>
Committed: Mon Jan 9 11:25:03 2017 +0800
----------------------------------------------------------------------
README.md | 124 ++++-----------------------------------
doc/en/docs/installation.md | 17 ++----
doc/notebook/index.ipynb | 64 ++++++++++++++++++++
tool/debian/build.sh | 6 +-
4 files changed, 84 insertions(+), 127 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a3446b5c/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index e631d39..5dc0c59 100644
--- a/README.md
+++ b/README.md
@@ -1,120 +1,22 @@
-# Jenkins CI Support
+#Apache SINGA
-## Introduction
-This documentation is to guide SINGA developers to setup Jenkins service.
+[](https://travis-ci.org/apache/incubator-singa)
+
-We use jenkins to support continuous integration.
-After each commit, we want to automatically compile and test SINGA
-under different OS and settings.
-Those built binaries need to be archived for users to download.
+Distributed deep learning system
-## Install Jenkins
-[Jenkins Official Wiki](https://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins)
-The slave nodes for running different building environments are configured under 'Manage Jenkins'->'Manage nodes'.
+[http://singa.apache.org](http://singa.apache.org)
-## Configure Jenkins Multi-configuration Project for Unit Testing and Package Generation
-Create a multi-configuration project and configure project as follows:
+## Quick Start
-### Description
-This job automatically pulls latest commits from Apache incubator-singa github repository, then for different environments
-* compile and test SINGA
-* create PySINGA wheel files
-* create Debian packages
+* [Installation](doc/en/docs/installation.md)
+* [Examples](examples)
-### General
- * Discard old builds - Max # of builds to keep - 50
- * GitHub project - ``https://github.com/apache/incubator-singa``
+## Issues
-### Source Code Management
- * Git - Repository URL - ``https://github.com/apache/incubator-singa``
- * Git - Branch Specifier - ``*/master``
+* [JIRA tickets](https://issues.apache.org/jira/browse/SINGA)
-### Build Triggers
- * Poll SCM - Schedule - ``H/30 * * * *`` (pull every 30 minutes)
+##Mailing Lists
-### Configuration Matrix
- * User-defined Axis - name ``lang`` values ``CPP CUDA``
- * Slave - name ``env`` Node/label ``tick all nodes``
-
-### Build
- * Execute shell - command - ``bash -ex tool/jenkins/jenkins_wheel.sh $lang``
-
-### Post-build Actions
- * Publish JUnit test result report - Test report XMLs - ``**/gtest.xml, **/unittest.xml``
- * (optional) Archive the artifacts - ``build/python/dist/**.whl, build/debian/**.deb``
- * Send build artifacts (wheel) over SSH
- * jenkins_wheel.sh packages the .whl file into $BUILD_ID.tar.gz. Inside the tar file,
- the folder layout is `build_id/commit_hash/os_lang/*.whl`, where `os_lang` is the combination of os version, device programming language (cuda/cpp/opencl) and cudnn version.
- * In `Manage Jenkins`-`Configure System`, configure the SSH for connecting to the remote public server and set the target folder location
- * Source files - `build/python/dist/*.tar.gz`
- * Remove prefix - `build/python/dist`
- * Remote directory - `wheel`
- * Exec a command on the remote server to decompress the package and add a symlink to the latest build. E.g., on a Solaris server the command is
-
- cd <target_folder>/wheel && gunzip $BUILD_ID.tar.gz && tar xf $BUILD_ID.tar && chmod -R 755 $BUILD_ID && /bin/rm -f $BUILD_ID.tar && /bin/rm -f latest && ln -s $BUILD_ID/* latest
-
- * The file links on the remote public server would be like
-
- wheel/32/84d56b7/ubuntu16.04-cpp/singa-1.0.1-py2-none-any.whl
- wheel/32/84d56b7/ubuntu16.04-cuda8.0-cudnn5/singa-1.0.1-py2-none-any.whl
-
- * Send build artifacts (Debian package) over SSH for wheel
- * ../debian/build.sh packages the .deb file into $BUILD_ID.tar.gz. Inside the tar file,
- the folder layout is `build_id/commit_hash/os_lang/*.deb`, where `os_lang` is the combination of os version, device programming language (cuda/cpp/opencl) and cudnn version.
- * In `Manage Jenkins`-`Configure System`, configure the SSH for connecting to the remote public server and set the target folder location
- * Source files - `build/debian/*.tar.gz`
- * Remove prefix - `build/debian
- * Remote directory - `debian`
- * Exec a command on the remote server to decompress the package and add a symlink to the latest build. E.g., on a Solaris server the command is
-
- cd <target_folder>/debian && gunzip $BUILD_ID.tar.gz && tar xf $BUILD_ID.tar && chmod -R 755 $BUILD_ID && /bin/rm -f $BUILD_ID.tar && /bin/rm -f latest && ln -s $BUILD_ID/* latest
-
- * The file links on the remote public server would be like
-
- debian/32/84d56b7/ubuntu16.04-cpp/singa-1.0.1-py2-none-any.whl
- debian/32/84d56b7/ubuntu16.04-cuda8.0-cudnn5/singa-1.0.1-py2-none-any.whl
-
-## Configure Jenkins for SINGA Website Updates
-
-### Description and Configuration
-
-This job is triggered upon any changes to the files of the `doc/` folder.
-It does the following tasks,
-
-1. installs the latest PySINGA
-2. pull the latest source code
-3. generate the html files for the documentation
-4. update the SINGA website
-
-The Jenkins job configuration is similar as above except the following fields,
-
-* Source Code Management - Git - Additional Behaviors - Include Region `doc/*`
-* Build - Execute Shell - Command `bash -ex tool/jenkins/jenkins_doc.sh`
-* No `Post-build Actions`
-
-### Docker Images
-
-The Docker image for the Jenkins slave node is at `docker/ubuntu16.04/runtime/Dockerfile`.
-To build the docker image,
-
- # under the docker/ubuntu16.04/runtime/ folder
- $ docker built -t singa:doc .
-
-To start the slave node
-
- $ docker run --name singa-doc -d singa:doc
- $ docker exec -it singa-doc /bin/bash
- $ svn co https://svn.apache.org/repos/asf/incubator/singa/site/trunk
- # update ~/.subversion/config to set 'store-password=yes'
- # to set password free commit, we have to do a manual commit at first.
- # change any file (add spaces) inside trunk/ to commit a message
- $ svn commit -m "test" --username <committer id> --password <passwd>
-
-## Docker Images
-We provide in `docker` a number of singa docker images for Jenkins to use as slaves.
-To run the docker images,
-
- nvidia-docker run --name <jenkins-slaveXX> -d <Image ID>
-
-## Access Control
-Use `Role Strategy Plugin` to give read access for anonymous users.
+* [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/))
http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a3446b5c/doc/en/docs/installation.md
----------------------------------------------------------------------
diff --git a/doc/en/docs/installation.md b/doc/en/docs/installation.md
index 4712ea2..fedb7b8 100755
--- a/doc/en/docs/installation.md
+++ b/doc/en/docs/installation.md
@@ -1,14 +1,5 @@
# Installation
-## Install with Debian packages
-
-Debian binary packages for Ubuntu/Debian operating systems are available:
-
-[SINGA-1.0.0 Python](http://www.comp.nus.edu.sg/~moaz/singa-python_1.0.0_amd64.deb)
-
-[SINGA-1.0.0 C++](http://www.comp.nus.edu.sg/~moaz/singa-cpp_1.0.0_amd64.deb)
-
-These packages are built for amd64 architecture. They provide SINGA CPU-only functions.
## Install PySINGA
@@ -110,14 +101,14 @@ We have prepared the Debian packages (on architecture: amd64) for SINGA as liste
| OS | Lang | CUDNN | Link |
|:---- |:------|------|:-------|:--------|
| Ubuntu14.04|CPP11|-|[latest](http://comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/latest/ubuntu14.04-cpp/), [history](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/)|
-| Ubuntu14.04|CUDA7.5|CUDNN4|[latest](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/latest/ubuntu14.04-cuda7.5-cudnn4/), [history](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/)|
-| Ubuntu14.04|CUDA7.5|CUDNN5|[latest](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/latest/ubuntu14.04-cuda7.5-cudnn5/), [history](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/)|
+| Ubuntu14.04|CUDA7.5|CUDNN4|coming soon|
+| Ubuntu14.04|CUDA7.5|CUDNN5|coming soon|
| Ubuntu16.04|CPP11|-|[latest](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/latest/ubuntu16.04-cpp/), [history](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/)|
-| Ubuntu16.04|CUDA8|CUDNN5|[latest](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/latest/ubuntu16.04-cuda8.0-cudnn5/), [history](http://www.comp.nus.edu.sg/~dbsystem/singa/assets/file/debian/)|
+| Ubuntu16.04|CUDA8|CUDNN5|coming soon|
Please download the deb file and install it via
- apt-get install <path to the deb file>
+ apt-get install <path to the deb file, e.g., ./python-singa.deb>
To create the Debian packages, please refer to the README.md file under `SINGA_ROOT/tool/debian`.
http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a3446b5c/doc/notebook/index.ipynb
----------------------------------------------------------------------
diff --git a/doc/notebook/index.ipynb b/doc/notebook/index.ipynb
new file mode 100644
index 0000000..f4e1e49
--- /dev/null
+++ b/doc/notebook/index.ipynb
@@ -0,0 +1,64 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ ""
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "Welcome to this tutorial for Apache Incubator-singa using Jupyter Notebook.\n",
+ "\n",
+ "Please install [PySINGA](http://singa.apache.org/en/docs/installation.html#install-pysinga) before running these tutorials.\n",
+ "\n",
+ "1. [Regression](../en/docs/notebook/regression.ipynb )\n",
+ "\n",
+ "2. [MLP Tutorial](../en/docs/notebook/mlp.ipynb)\n",
+ "\n",
+ "3. [RBM Tutorial](../en/docs/notebook/rbm.ipynb)\n",
+ "\n",
+ "\n",
+ "To learn more about Jupyter, please check [IPython in Depth](https://www.youtube.com/watch?v=xe_ATRmw0KM).\n",
+ "\n",
+ "If you want to use PySINGA and jupyter notebooks in virtual environment, please use conda virtual environment and install the following extension. Then you can select the kernel of the virtual environment in the browser. "
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {
+ "collapsed": false
+ },
+ "outputs": [],
+ "source": [
+ "conda install nb_conda_kernel"
+ ]
+ }
+ ],
+ "metadata": {
+ "anaconda-cloud": {},
+ "kernelspec": {
+ "display_name": "Python [default]",
+ "language": "python",
+ "name": "python2"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 2
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython2",
+ "version": "2.7.12"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}
http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/a3446b5c/tool/debian/build.sh
----------------------------------------------------------------------
diff --git a/tool/debian/build.sh b/tool/debian/build.sh
index 43a21cb..9d30995 100755
--- a/tool/debian/build.sh
+++ b/tool/debian/build.sh
@@ -109,9 +109,9 @@ fi
# remove unnecessary dependencies
if [ $MODULES = "ON" ]; then
- sed -i 's/<libopenblas-dev\>,*//' build/debian/$FOLDER/DEBIAN/control
- sed -i 's/<libprotobuf-dev\>,*//' build/debian/$FOLDER/DEBIAN/control
- sed -i 's/<protobuf-compiler\>,*//' build/debian/$FOLDER/DEBIAN/control
+ sed -i 's/libopenblas-dev,//' build/debian/$FOLDER/DEBIAN/control
+ sed -i 's/libprotobuf-dev,//' build/debian/$FOLDER/DEBIAN/control
+ sed -i 's/protobuf-compiler,//' build/debian/$FOLDER/DEBIAN/control
fi
# copy cpp and cuda files