Merge pull request #259 from datmo/new-hello-world

New hello world in docs/readme

README.md

@@ -45,6 +45,7 @@ feel free contribute by adding issues so the contributors can address them.
 ### Table of Contents
 * [Requirements](#requirements)
 * [Installation](#installation)
+* [Hello World](#hello-world)
 * [Examples](#examples)
 * [Documentation](#documentation)
 * [Transform a Current Project](#transform)
@@ -60,6 +61,9 @@ feel free contribute by adding issues so the contributors can address them.
 pip install datmo
 ```
 
+## Hello-World
+Our hello world guide includes showing environment setup and changes, as well as experiment reproducibility. It's available [in our docs here](https://datmo.readthedocs.io/en/latest/quickstart.html).
+
 ## Examples
 In the `/examples` folder we have a few scripts you can run to get a feel for datmo. You can 
 navigate to [Examples](/examples/README.md) to learn more about how you can run the examples 

docs/quickstart.rst

@@ -1,6 +1,74 @@
 Quickstart
 ===================================
 
+Hello World
+-----------------
+
+Setup:
+
+    - docker (installed and running before starting)    
+
+    - datmo (install with ``$ pip install datmo``)
+
+
+Steps:
+
+1. Clone this github `project <https://github.com/datmo/hello-world.git>`_.
+
+``$ git clone https://github.com/datmo/hello-world.git``
+
+2. Move into the project, initialize it, and setup the environment using the datmo CLI,
+::
+   $ cd hello-world
+   $ # Initialize the project using datmo
+   $ datmo init
+   $ # Set the name and description for the project
+   $ # Enter `y` to setup the environment
+   $ # Select `cpu`, `data-analytics`, `py27` based on the questions being asked   
+
+3. Now, run and view your first experiment using the following commands,
+::
+   $ datmo run 'python script.py'
+   $ # check for your first run using ls command
+   $ datmo ls
+
+4. Now let's change the environment and script for a new run,
+
+To edit the environment,
+
+``$ vi datmo_environment/Dockerfile``
+
+Add the following line into this `Dockerfile`
+::
+   RUN pip install catboost
+
+To edit the script,
+
+``$ vi script.py``
+
+Uncomment the following lines in the script,
+::
+   # import catboost
+   # print catboost.__version__
+
+
+5. Now that we have updated the environment and script, let's run another experiment,
+::
+   $ datmo run 'python script.py'
+   $ # check for your first run using ls command
+   $ datmo ls
+
+6. With two test being tracked, we can now rerun any of the previous run with reprocibility,
+::
+   $ # Select the earlier run-id to rerun the first experiment
+   $ datmo rerun < run-id >
+
+Now, in this hello-world example, you have run two experiments, both which are tracked, and have 
+rerun one of these tracked experiments.
+
+
+--------
+
 Spinning up a TensorFlow Jupyter Notebook
 --------------------------------------------
 
@@ -31,8 +99,7 @@ Congrats, you now have a functional jupyter notebook with TensorFlow!
 
 --------
 
-Testing it out
-------------------------
+Testing it out:
 
 1. Navigate to the notebook by typing the following into your browser: