Add samples for the Cloud ML Engine

ml_engine/online_prediction/predict.py

@@ -0,0 +1,173 @@
+# Copyright 2016 Google Inc. All Rights Reserved. Licensed under the Apache
+# License, Version 2.0 (the "License"); you may not use this file except in
+# compliance with the License. You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+"""Examples of using the Cloud ML Engine's online prediction service."""
+from __future__ import print_function
+# [START import_libraries]
+import googleapiclient.discovery
+# [END import_libraries]
+
+
+# [START authenticating]
+def get_ml_engine_service():
+    """Create the ML Engine service object.
+    To authenticate set the environment variable
+    GOOGLE_APPLICATION_CREDENTIALS=<path_to_service_account_file>
+    """
+    return googleapiclient.discovery.build('ml', 'v1beta1')
+# [END authenticating]
+
+
+# [START predict_json]
+def predict_json(project, model, instances, version=None):
+    """Send data instances to a deployed model for prediction
+    Args:
+        project: str, project where the Cloud ML Engine Model is deployed.
+        model: str, model name.
+        instances: [dict], dictionaries from string keys defined by the model
+        to data.
+        version: [optional] str, version of the model to target.
+    Returns:
+        A dictionary of prediction results defined by the model.
+    """
+    service = get_ml_engine_service()
+    name = 'projects/{}/models/{}'.format(project, model)
+    if version is not None:
+        name += '/versions/{}'.format(version)
+
+    response = service.projects().predict(
+        name=name,
+        body={'instances': instances}
+    ).execute()
+
+    if 'error' in response:
+        raise RuntimeError(response['error'])
+
+    return response['predictions']
+# [END predict_json]
+
+
+# [START predict_tf_records]
+def predict_tf_records(project,
+                       model,
+                       example_bytes_list,
+                       key='tfrecord',
+                       version=None):
+    """Send data instances to a deployed model for prediction
+    Args:
+        project: str, project where the Cloud ML Engine Model is deployed
+        model: str, model name.
+        example_bytes_list: [str], Serialized tf.train.Example protos.
+        version: str, version of the model to target.
+    Returns:
+        A dictionary of prediction results defined by the model.
+    """
+    import base64
+    service = get_ml_engine_service()
+    name = 'projects/{}/models/{}'.format(project, model)
+    if version is not None:
+        name += '/versions/{}'.format(version)
+
+    response = service.projects().predict(
+        name=name,
+        body={'instances': [
+            {key: {'b64': base64.b64encode(example_bytes)}}
+            for example_bytes in example_bytes_list
+        ]}
+    ).execute()
+    if 'error' in response:
+        raise RuntimeError(response['error'])
+
+    return response['predictions']
+# [END predict_tf_records]
+
+
+# [START census_to_example_bytes]
+def census_to_example_bytes(json_instance):
+    """Serialize a JSON example to the bytes of a tf.train.Example.
+    This method is specific to the signature of the Census example.
+    Args:
+        json_instance: dict, representing data to be serialized.
+    Returns:
+        A string (as a container for bytes).
+    """
+    import tensorflow as tf
+    feature_dict = {}
+    for key, data in json_instance.iteritems():
+        if isinstance(data, str) or isinstance(data, unicode):
+            feature_dict[key] = tf.train.Feature(
+                bytes_list=tf.train.BytesList(value=[str(data)]))
+        elif isinstance(data, int) or isinstance(data, float):
+            feature_dict[key] = tf.train.Feature(
+                float_list=tf.train.FloatList(value=[data]))
+    return tf.train.Example(
+        features=tf.train.Features(
+            feature=feature_dict
+        )
+    ).SerializeToString()
+# [END census_to_example_bytes]
+
+
+def main(project, model, version=None, force_tfrecord=False):
+    """Send user input to the prediction service."""
+    import json
+    while True:
+        try:
+            user_input = json.loads(raw_input("Valid JSON >>>"))
+        except KeyboardInterrupt:
+            return
+
+        if not isinstance(user_input, list):
+            user_input = [user_input]
+        try:
+            if force_tfrecord:
+                example_bytes_list = [
+                    census_to_example_bytes(e)
+                    for e in user_input
+                ]
+                result = predict_tf_records(
+                    project, model, example_bytes_list, version=version)
+            else:
+                result = predict_json(
+                    project, model, user_input, version=version)
+        except RuntimeError as err:
+            print(str(err))
+        else:
+            print(result)
+
+
+if __name__ == '__main__':
+    import argparse
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        '--project',
+        help='Project in which the model is deployed',
+        type=str,
+        required=True
+    )
+    parser.add_argument(
+        '--model',
+        help='Model name',
+        type=str,
+        required=True
+    )
+    parser.add_argument(
+        '--version',
+        help='Name of the version.',
+        type=str
+    )
+    parser.add_argument(
+        '--force-tfrecord',
+        help='Send predictions as TFRecords rather than raw JSON',
+        action='store_true',
+        default=False
+    )
+    args = parser.parse_args()
+    main(**args.__dict__)

ml_engine/online_prediction/predict_test.py

@@ -0,0 +1,64 @@
+# Copyright 2016 Google Inc. All Rights Reserved. Licensed under the Apache
+# License, Version 2.0 (the "License"); you may not use this file except in
+# compliance with the License. You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+"""Tests for predict.py ."""
+import base64
+
+import pytest
+
+from predict import census_to_example_bytes, predict_json
+
+
+MODEL = 'census'
+VERSION = 'v1'
+PROJECT = 'python-docs-samples-tests'
+JSON = {
+    'age': 25,
+    'workclass': ' Private',
+    'education': ' 11th',
+    'education_num': 7,
+    'marital_status': ' Never-married',
+    'occupation': ' Machine-op-inspct',
+    'relationship': ' Own-child',
+    'race': ' Black',
+    'gender': ' Male',
+    'capital_gain': 0,
+    'capital_loss': 0,
+    'hours_per_week': 40,
+    'native_country': ' United-States'
+}
+EXPECTED_OUTPUT = {
+    u'probabilities': [0.9942260384559631, 0.005774002522230148],
+    u'logits': [-5.148599147796631],
+    u'classes': 0,
+    u'logistic': [0.005774001590907574]
+}
+
+
+def test_predict_json():
+    result = predict_json(PROJECT, MODEL, [JSON, JSON], version=VERSION)
+    assert [EXPECTED_OUTPUT, EXPECTED_OUTPUT] == result
+
+
+def test_predict_json_error():
+    with pytest.raises(RuntimeError):
+        predict_json(PROJECT, MODEL, [{"foo": "bar"}], version=VERSION)
+
+
+def test_census_example_to_bytes():
+    b = census_to_example_bytes(JSON)
+    assert base64.b64encode(b) is not None
+
+
+def test_predict_tfrecord():
+    # Using the same model for TFRecords and
+    # JSON is currently broken.
+    # TODO(elibixby) when b/35742966 is fixed add
+    pass

ml_engine/online_prediction/requirements.txt

@@ -0,0 +1 @@
+tensorflow>=1.0.0