Fixed some Markdown formatting and moved the Buzz README to the correct location.
[arvados.git] / examples / prediction / README.md
index bba1bae06421688eb9034bb99b973d8d6c0ca895..38932da8650446a4cd88d69cc288900d7bc4c754 100644 (file)
@@ -15,7 +15,8 @@ formatted data into Google Storage.
 1 - You must first create the bucket you want to use. This can be done 
 with the gsutil function or via the web UI (Storage Access) in the Google 
 APIs Console. i.e. 
-`$ gsutil mb gs://BUCKET`
+
+    $ gsutil mb gs://BUCKET
 
 OR
 
@@ -25,12 +26,13 @@ and create your bucket there.
 2 - We now load the data you want to use to Google Storage. We have supplied a
 basic language identification dataset in the sample for testing.
 
-`$ chmod 744 setup.sh`
-`$ ./setup.sh BUCKET/OBJECT`
+    $ chmod 744 setup.sh
+    $ ./setup.sh BUCKET/OBJECT
 Note you need gsutil in your path for this to work.
 
 If you have your own dataset, you can do this manually as well.
-`$ gsutil cp your_dataset.csv gs://BUCKET/your_dataset.csv`
+
+    $ gsutil cp your_dataset.csv gs://BUCKET/your_dataset.csv
 
 
 In the script, you must then modify the datafile string. This must correspond with the
@@ -51,8 +53,8 @@ API. You can also set it up so the user can grant access.
 
 First, run the google-api script to generate access and refresh tokens. Ex.
 
-`$ cd google-api-ruby-client`
-`$ ruby bin/google-api oauth-2-login --scope=https://www.googleapis.com/auth/prediction --client-id=NUMBER.apps.googleusercontent.com --client-secret=CLIENT_SECRET`
+    $ cd google-api-ruby-client
+    $ ruby bin/google-api oauth-2-login --scope=https://www.googleapis.com/auth/prediction --client-id=NUMBER.apps.googleusercontent.com --client-secret=CLIENT_SECRET
 
 Fill in your client-id and client-secret from the API Access page. You will
 probably have to set a redirect URI in your client ID
@@ -81,7 +83,8 @@ At this, point, you should have
    loading the generated .yaml file
  
 We can now run the service! 
-`$ ruby prediction.rb`
+
+    $ ruby prediction.rb
 
 This should start a service on `http://localhost:4567`. When you hit the service,
 your ruby logs should show the Prediction API calls, and print the prediction
@@ -91,4 +94,3 @@ This sample currently does not cover some newer features of Prediction API such
 as streaming training, hosted models or class weights. If there are any
 questions or suggestions to improve the script please email us at
 prediction-api-discuss@googlegroups.com.
-