Merge pull request #89 from IBM/rebased-notebook

Documentation Changes to Demo notebook from Rebased notebook branch

README.md

@@ -112,6 +112,9 @@ for creating and managing the Ray cluster and [KubeRay API server](https://githu
 to interact with the KubeRay operator. An additional [framework](kfp/kfp_support_lib) along with several
 [kfp components](kfp/kfp_ray_components) is used to simplify the pipeline implementation.
 
+#### Example Notebook
+A quick way to get started is to use a demo data-processing pipeline locally via [example notebook](./examples/).  
+
 
 ## &#x2699; Setup <a name = "setup"></a>
 

examples/Makefile

@@ -0,0 +1,14 @@
+REPOROOT=../
+# Use make help, to see the available rules
+
+include ../.make.defaults
+
+clean:: .defaults.clean
+
+venv:: .defaults.lib-src-venv
+	@# Help: Install requirements from all transforms into a venv 
+	. ./venv/bin/activate && bash ./prepare_env.sh
+
+jupyter::
+	@# Help: Activate the venv and start the example notebook  
+	. ./venv/bin/activate && . ./launch.sh

examples/README.md

@@ -0,0 +1,20 @@
+## Demo Notebook
+
+We can launch a jupyter notebook to try out the library or transforms or to build a usecase.
+
+
+## One time Step
+
+1. Run this step install the dependancies. 
+
+**Prepare virtualenv**
+
+`make venv`
+
+## Launch
+
+2. After dependancies are installed, we can launch the jupyter notebook
+
+`make jupyter`
+
+It will launch browser with the jupyter notebook where we can try out the transforms.