automl: add base model samples for automl ga [(#2609)](#2609)

* automl: add base model samples for automl ga

* Add tests for each file, provide a unique model for each python version for kokoro

* Fix version check

* Update tests and format

* Update deploy_model_test.py

* Update license headers, ensure double quotes is used everywhere, leave black formatting

automl/snippets/delete_model.py

@@ -0,0 +1,31 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+
+def delete_model(project_id, model_id):
+    """Delete a model."""
+    # [START automl_delete_model]
+    from google.cloud import automl
+
+    # TODO(developer): Uncomment and set the following variables
+    # project_id = "YOUR_PROJECT_ID"
+    # model_id = "YOUR_MODEL_ID"
+
+    client = automl.AutoMlClient()
+    # Get the full path of the model.
+    model_full_id = client.model_path(project_id, "us-central1", model_id)
+    response = client.delete_model(model_full_id)
+
+    print("Model deleted. {}".format(response.result()))
+    # [END automl_delete_model]

automl/snippets/delete_model_test.py

@@ -0,0 +1,31 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+import os
+
+import delete_model
+
+PROJECT_ID = os.environ["GCLOUD_PROJECT"]
+
+
+def test_delete_model(capsys):
+    # As model creation can take many hours, instead try to delete a
+    # nonexistent model and confirm that the model was not found, but other
+    # elements of the request were valid.
+    try:
+        delete_model.delete_model(PROJECT_ID, "TRL0000000000000000000")
+        out, _ = capsys.readouterr()
+        assert "The model does not exist" in out
+    except Exception as e:
+        assert "The model does not exist" in e.message

automl/snippets/deploy_model.py

@@ -0,0 +1,31 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+
+def deploy_model(project_id, model_id):
+    """Deploy a model."""
+    # [START automl_deploy_model]
+    from google.cloud import automl
+
+    # TODO(developer): Uncomment and set the following variables
+    # project_id = "YOUR_PROJECT_ID"
+    # model_id = "YOUR_MODEL_ID"
+
+    client = automl.AutoMlClient()
+    # Get the full path of the model.
+    model_full_id = client.model_path(project_id, "us-central1", model_id)
+    response = client.deploy_model(model_full_id)
+
+    print("Model deployment finished. {}".format(response.result()))
+    # [END automl_deploy_model]

automl/snippets/deploy_model_test.py

@@ -0,0 +1,35 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+import os
+
+import pytest
+
+import deploy_model
+
+PROJECT_ID = os.environ["GCLOUD_PROJECT"]
+MODEL_ID = "TRL0000000000000000000"
+
+
+@pytest.mark.slow
+def test_deploy_model(capsys):
+    # As model deployment can take a long time, instead try to deploy a
+    # nonexistent model and confirm that the model was not found, but other
+    # elements of the request were valid.
+    try:
+        deploy_model.deploy_model(PROJECT_ID, MODEL_ID)
+        out, _ = capsys.readouterr()
+        assert "The model does not exist" in out
+    except Exception as e:
+        assert "The model does not exist" in e.message

automl/snippets/get_model.py

@@ -0,0 +1,44 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+
+def get_model(project_id, model_id):
+    """Get a model."""
+    # [START automl_get_model]
+    from google.cloud import automl
+
+    # TODO(developer): Uncomment and set the following variables
+    # project_id = "YOUR_PROJECT_ID"
+    # model_id = "YOUR_MODEL_ID"
+
+    client = automl.AutoMlClient()
+    # Get the full path of the model.
+    model_full_id = client.model_path(project_id, "us-central1", model_id)
+    model = client.get_model(model_full_id)
+
+    # Retrieve deployment state.
+    if model.deployment_state == automl.enums.Model.DeploymentState.DEPLOYED:
+        deployment_state = "deployed"
+    else:
+        deployment_state = "undeployed"
+
+    # Display the model information.
+    print("Model name: {}".format(model.name))
+    print("Model id: {}".format(model.name.split("/")[-1]))
+    print("Model display name: {}".format(model.display_name))
+    print("Model create time:")
+    print("\tseconds: {}".format(model.create_time.seconds))
+    print("\tnanos: {}".format(model.create_time.nanos))
+    print("Model deployment state: {}".format(deployment_state))
+    # [END automl_get_model]

automl/snippets/get_model_evaluation.py

@@ -0,0 +1,92 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+
+def get_model_evaluation(project_id, model_id, model_evaluation_id):
+    """Get model evaluation."""
+    # [START automl_language_entity_extraction_get_model_evaluation]
+    # [START automl_language_sentiment_analysis_get_model_evaluation]
+    # [START automl_language_text_classification_get_model_evaluation]
+    # [START automl_translate_get_model_evaluation]
+    # [START automl_vision_classification_get_model_evaluation]
+    # [START automl_vision_object_detection_get_model_evaluation]
+    from google.cloud import automl
+
+    # TODO(developer): Uncomment and set the following variables
+    # project_id = "YOUR_PROJECT_ID"
+    # model_id = "YOUR_MODEL_ID"
+    # model_evaluation_id = "YOUR_MODEL_EVALUATION_ID"
+
+    client = automl.AutoMlClient()
+    # Get the full path of the model evaluation.
+    model_evaluation_full_id = client.model_evaluation_path(
+        project_id, "us-central1", model_id, model_evaluation_id
+    )
+
+    # Get complete detail of the model evaluation.
+    response = client.get_model_evaluation(model_evaluation_full_id)
+
+    print("Model evaluation name: {}".format(response.name))
+    print("Model annotation spec id: {}".format(response.annotation_spec_id))
+    print("Create Time:")
+    print("\tseconds: {}".format(response.create_time.seconds))
+    print("\tnanos: {}".format(response.create_time.nanos / 1e9))
+    print(
+        "Evaluation example count: {}".format(response.evaluated_example_count)
+    )
+    # [END automl_language_sentiment_analysis_get_model_evaluation]
+    # [END automl_language_text_classification_get_model_evaluation]
+    # [END automl_translate_get_model_evaluation]
+    # [END automl_vision_classification_get_model_evaluation]
+    # [END automl_vision_object_detection_get_model_evaluation]
+    print(
+        "Entity extraction model evaluation metrics: {}".format(
+            response.text_extraction_evaluation_metrics
+        )
+    )
+    # [END automl_language_entity_extraction_get_model_evaluation]
+
+    # [START automl_language_sentiment_analysis_get_model_evaluation]
+    print(
+        "Sentiment analysis model evaluation metrics: {}".format(
+            response.text_sentiment_evaluation_metrics
+        )
+    )
+    # [END automl_language_sentiment_analysis_get_model_evaluation]
+
+    # [START automl_language_text_classification_get_model_evaluation]
+    # [START automl_vision_classification_get_model_evaluation]
+    print(
+        "Classification model evaluation metrics: {}".format(
+            response.classification_evaluation_metrics
+        )
+    )
+    # [END automl_language_text_classification_get_model_evaluation]
+    # [END automl_vision_classification_get_model_evaluation]
+
+    # [START automl_translate_get_model_evaluation]
+    print(
+        "Translation model evaluation metrics: {}".format(
+            response.translation_evaluation_metrics
+        )
+    )
+    # [END automl_translate_get_model_evaluation]
+
+    # [START automl_vision_object_detection_get_model_evaluation]
+    print(
+        "Object detection model evaluation metrics: {}".format(
+            response.image_object_detection_evaluation_metrics
+        )
+    )
+    # [END automl_vision_object_detection_get_model_evaluation]

automl/snippets/get_model_evaluation_test.py

@@ -0,0 +1,46 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+import os
+
+import pytest
+
+import get_model_evaluation
+
+PROJECT_ID = os.environ["GCLOUD_PROJECT"]
+MODEL_ID = "TEN1499896588007374848"
+
+
+@pytest.fixture(scope="function")
+def get_evaluation_id():
+    from google.cloud import automl
+
+    client = automl.AutoMlClient()
+    model_full_id = client.model_path(PROJECT_ID, "us-central1", MODEL_ID)
+    evaluation = None
+    for e in client.list_model_evaluations(model_full_id, ""):
+        evaluation = e
+        break
+    model_evaluation_id = evaluation.name.split(
+        "{}/modelEvaluations/".format(MODEL_ID)
+    )[1].split("\n")[0]
+    yield model_evaluation_id
+
+
+def test_get_model_evaluation(capsys, get_evaluation_id):
+    get_model_evaluation.get_model_evaluation(
+        PROJECT_ID, MODEL_ID, get_evaluation_id
+    )
+    out, _ = capsys.readouterr()
+    assert "Model evaluation name: " in out

automl/snippets/get_model_test.py

@@ -0,0 +1,26 @@
+# Copyright 2019 Google LLC
+#
+# 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.
+
+import os
+
+import get_model
+
+PROJECT_ID = os.environ["GCLOUD_PROJECT"]
+MODEL_ID = "TEN1499896588007374848"
+
+
+def test_get_model(capsys):
+    get_model.get_model(PROJECT_ID, MODEL_ID)
+    out, _ = capsys.readouterr()
+    assert "Model id: " in out