[05/17] incubator-singa git commit: SINGA-268 Add IPython notebooks to the documentation

[wa...@apache.org]

SINGA-268 Add IPython notebooks to the documentation


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

Branch: refs/heads/master
Commit: 7da4455ec0c53e0cd7ee82bb0eb14b9f11772dbb
Parents: 5afd81c
Author: Moaz Reyad <mo...@gmail.com>
Authored: Tue Nov 8 16:00:44 2016 +0800
Committer: Wei Wang <wa...@comp.nus.edu.sg>
Committed: Tue Nov 22 20:40:38 2016 +0800

----------------------------------------------------------------------
 doc/en/index.rst              |   2 +
 doc/notebook/README.md        |   3 +
 doc/notebook/index.ipynb      |  51 ++++++
 doc/notebook/mlp.ipynb        | 290 +++++++++++++++++++++++++++++++++++
 doc/notebook/rbm.ipynb        | 307 +++++++++++++++++++++++++++++++++++++
 doc/notebook/regression.ipynb | 187 ++++++++++++++++++++++
 doc/notebook/utils.py         | 138 +++++++++++++++++
 7 files changed, 978 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/7da4455e/doc/en/index.rst
----------------------------------------------------------------------
diff --git a/doc/en/index.rst b/doc/en/index.rst
index 284b919..968c237 100755
--- a/doc/en/index.rst
+++ b/doc/en/index.rst
@@ -64,6 +64,8 @@ Getting Started
 
 * Please follow the `Examples <docs/examples/index.html>`_ guide to run simple applications on SINGA.
 
+* More exmaples in `Jupyter <http://jupyter.org/>`_ (IPython) can be open in `notebook viewer <http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/notebook/index.ipynb>`_ .
+
 Documentation
 -------------
 

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/7da4455e/doc/notebook/README.md
----------------------------------------------------------------------
diff --git a/doc/notebook/README.md b/doc/notebook/README.md
new file mode 100644
index 0000000..ee7b018
--- /dev/null
+++ b/doc/notebook/README.md
@@ -0,0 +1,3 @@
+These are some examples in IPython notebooks.
+
+You can open them in [notebook viewer](http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/notebook/index.ipynb).

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/7da4455e/doc/notebook/index.ipynb
----------------------------------------------------------------------
diff --git a/doc/notebook/index.ipynb b/doc/notebook/index.ipynb
new file mode 100644
index 0000000..5de71d6
--- /dev/null
+++ b/doc/notebook/index.ipynb
@@ -0,0 +1,51 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "![Apache Singa](http://singa.apache.org/en/_static/singa.png)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Welcome to this tutorial for Apache Singa using Jupyter Notebook.\n",
+    "\n",
+    "Please install PySinga before running these tutorials.\n",
+    "\n",
+    "1. [Regression](http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/notebook/regression.ipynb )\n",
+    "\n",
+    "2. [MLP Tutorial](http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/notebook/mlp.ipynb)\n",
+    "\n",
+    "3. [RBM Tutorial](\n",
+    "http://nbviewer.jupyter.org/github/apache/incubator-singa/blob/master/doc/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"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 2",
+   "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
+}