read

examples/prediction/README

@@ -1,14 +1,38 @@
+APIs Console Project Setup:
+------------
+If you have not yet, you must set your APIs Console project to enable Prediction
+API and Google Storage. Go to APIs Console https://code.google.com/apis/console/
+and select the project you want to use. Next, go to Services, and enable both
+Prediction API and Google Storage. You may also need to enable Billing (Billing)
+in the left menu.
+
+
 Data Setup:
 ----------
 Before you can run the prediction sample prediction.rb, you must load some csv
-formatted data into Google Storage. You can do this by running setup.sh with a 
-bucket/object name of your choice. 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.:
+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
+
+OR
+
+Go to APIs Console -> Storage Access (on left) and the Google Storage Manager,
+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
 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
+
+
 In the script, you must then modify the datafile string. This must correspond with the
 bucket/object of your dataset (if you are using your own dataset). We have
 provided a setup.sh which will upload some basic sample data. The section is
@@ -28,7 +52,7 @@ 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-1.9.2-p290  bin/google-api oauth-2-login --scope=https://www.googleapis.com/auth/prediction --client-id=NUMBER.apps.googleusercontent.com --client-secret=CLIENT_SECRET
+# 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
@@ -46,6 +70,25 @@ you are loading it as a yaml, ensure you rename/move the file, as the
 move the .google-api.yaml file to the sample directory.
 
 
+Usage :
+-------
+At this, point, you should have 
+ - Enabled your APIs Console account
+ - Created a storage bucket, if required
+ - Uploaded some data to Google Storage
+ - Modified the script to point the 'datafile' variable to the BUCKET/OBJECT  name
+ - Modified the script to put your credentials in, either in the code or by
+   loading the generated .yaml file
+ 
+We can now run the service! 
+# 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
+output in the debug. 
+
+
+
 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