feat: Added deploy_model_with_dedicated_resources_sample, deploy_model_with_automatic_resources_sample, upload_model and get_model samples #337

ivanmkc · 2021-04-17T03:40:51Z

Added deploy_model_with_dedicated_resources_sample, deploy_model_with_automatic_resources_sample, upload_model and get_model samples and tests.

snippet-bot · 2021-04-17T03:40:56Z

Here is the summary of changes.

You are about to add 4 region tags.

samples/model-builder/deploy_model_with_automatic_resources_sample.py:20, tag aiplatform_sdk_deploy_model_with_automatic_resources_sample
samples/model-builder/deploy_model_with_dedicated_resources_sample.py:21, tag aiplatform_sdk_deploy_model_with_dedicated_resources_sample
samples/model-builder/get_model_sample.py:19, tag aiplatform_sdk_get_model_sample
samples/model-builder/upload_model_sample.py:21, tag aiplatform_sdk_upload_model_sample

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

ivanmkc · 2021-04-19T20:07:14Z

samples/model-builder/test_constants.py

@@ -16,6 +16,7 @@
 from uuid import uuid4

 from google.auth import credentials
+from google.cloud import aiplatform


I needed to import this for aiplatform.explain.ExplanationMetadata

ivanmkc · 2021-04-19T20:13:56Z

samples/model-builder/conftest.py

+        yield mock
+
+@pytest.fixture
+def mock_batch_predict_model(mock_model):


Updated these fixtures to use the new mock_model

sasha-gitg · 2021-04-21T15:29:11Z

samples/model-builder/deploy_model_custom_trained_model_sample.py

+    deployed_model_display_name: Optional[str] = None,
+    traffic_percentage: Optional[int] = 0,
+    traffic_split: Optional[Dict[str, int]] = None,    
+    min_replica_count: Optional[int] = 1,


Please remove the Optional type hint (just leave int) on min_replica_count and max_replica_count. After reviewing this, I realized Endpoint.deploy and Model.deploy have inconsistent types on those arguments. I opened a PR to fix the function type hints in the SDK here: #345

sasha-gitg · 2021-04-21T15:30:45Z

samples/model-builder/deploy_model_sample.py

+    deployed_model_display_name: Optional[str] = None,
+    traffic_percentage: Optional[int] = 0,
+    traffic_split: Optional[Dict[str, int]] = None,
+    min_replica_count: Optional[int] = 1,


Same comment on min_replica_count and max_replica_count

sasha-gitg · 2021-04-21T15:32:43Z

samples/model-builder/deploy_model_sample.py

+from google.cloud.aiplatform import explain
+
+#  [START aiplatform_sdk_deploy_model_sample]
+def deploy_model_sample(


I'm assuming this is for models with automatic resources as machine type is not exposed. If that's the case, I think the following arguments can be removed but please confirm:

accelerator_type
accelerator_count
explanation_metadata
explanation_parameters

Yes it's for automatic resources.

I checked the internal deploy function and it looks like accelerator_type and accelerator_count are only used if machine-type is provided. However, even if it intuitively makes sense, I would argue that the docstrings should make their co-dependence clear.

I would also recommend a refactor to bundle machine_type, accelerator_type and accelerator_count together, since they can't be used independently. If you want to keep the user-facing API flat, that's fine but in private functions it will be cleaner bundled. This would also reduce duplication of logic (search for if machine_type:). Let me know if you agree, and I can do this in a new PR.

From looking at _deploy_call, I don't see explanation_metadata and explanation_parameters relying on machine_type being set. Is there some restriction from the service the requires `machine_type?

Agree on the refactor and updating the docstring. Only custom models take explanation_metadata and explanation_parameters as AutoMLs support it natively (if supported) and machine_type is required from custom models.

@vinnysenthil to confirm

@sasha-gitg Logged a bug for refactor: https://b.corp.google.com/issues/186121905

sasha-gitg · 2021-04-23T13:37:47Z

samples/model-builder/deploy_model_sample.py

+
+    model = aiplatform.Model(model_name=model_name)
+
+    # AutoML models require a machine_type of None


@vinnysenthil do all AutoML Models require automatic resources?

Actually, we talked about this and it's a little unclear what the truth of this is.

We're still trying to find out the answer from the predict team.

@sasha-gitg I talked to prediction team and unfortunately, they do not have the answer. I will remove the comment for now and update this if I find out more.

ivanmkc requested a review from vinnysenthil April 17, 2021 03:40

ivanmkc requested review from dizcology and a team as code owners April 17, 2021 03:40

ivanmkc requested review from engelke and removed request for a team April 17, 2021 03:40

product-auto-label bot added api: aiplatform Issues related to the AI Platform API. samples Issues that are directly related to samples. labels Apr 17, 2021

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Apr 17, 2021

ivanmkc changed the base branch from master to dev April 17, 2021 03:56

ivanmkc force-pushed the imkc--mbsdk-samples-milestone1 branch from 32ef90b to 7a646b4 Compare April 17, 2021 04:00

ivanmkc commented Apr 19, 2021

View reviewed changes

ivanmkc changed the title ~~[WIP] Added deploy_model and upload_model samples and tests~~ Added deploy_model and upload_model samples and tests Apr 19, 2021

ivanmkc changed the title ~~Added deploy_model and upload_model samples and tests~~ feat: Added deploy_model and upload_model samples and tests Apr 19, 2021

ivanmkc commented Apr 19, 2021

View reviewed changes

ivanmkc changed the title ~~feat: Added deploy_model and upload_model samples and tests~~ feat: Added deploy_model, upload_model, get_model samples and tests Apr 19, 2021

ivanmkc changed the title ~~feat: Added deploy_model, upload_model, get_model samples and tests~~ feat: Added deploy_model, upload_model, get_model samples and deploy_model_custom_trained_model_sample. Apr 19, 2021

ivanmkc changed the title ~~feat: Added deploy_model, upload_model, get_model samples and deploy_model_custom_trained_model_sample.~~ feat: Added deploy_model, upload_model, get_model samples and deploy_model_custom_trained_model_sample Apr 19, 2021

ivanmkc force-pushed the imkc--mbsdk-samples-milestone1 branch 2 times, most recently from e4be6f4 to 704ca9f Compare April 21, 2021 00:55

sasha-gitg requested changes Apr 21, 2021

View reviewed changes

ivanmkc force-pushed the imkc--mbsdk-samples-milestone1 branch from 30acf42 to bd4e0a8 Compare April 21, 2021 16:59

ivanmkc mentioned this pull request Apr 21, 2021

feat: Added explain tabular samples #348

Merged

sasha-gitg reviewed Apr 23, 2021

View reviewed changes

ivanmkc changed the title ~~feat: Added deploy_model, upload_model, get_model samples and deploy_model_custom_trained_model_sample~~ feat: Added deploy_model_with_dedicated_resources_sample, deploy_model_with_automatic_resources_sample, upload_model and get_model samples Apr 27, 2021

sasha-gitg approved these changes Apr 27, 2021

View reviewed changes

ivanmkc added kokoro:force-run Add this label to force Kokoro to re-run the tests. and removed kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Apr 27, 2021

ivanmkc added the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 29, 2021

yoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Apr 29, 2021

vinnysenthil approved these changes Apr 30, 2021

View reviewed changes

vinnysenthil changed the base branch from dev to master April 30, 2021 17:09

dizcology approved these changes Apr 30, 2021

View reviewed changes

ivanmkc force-pushed the imkc--mbsdk-samples-milestone1 branch from 035197f to d8c3d8a Compare April 30, 2021 17:47

ivanmkc requested a review from a team as a code owner April 30, 2021 17:47

ivanmkc added 15 commits April 30, 2021 14:14

Added deploy_model and upload_model samples

eb6e2da

Fixed tests

a4c7def

Fixed tests

2bcca9f

Added get_model sample and fixed errors

cb5c2dc

Added get_model sample and fixed errors

5d9c32e

Added get_model sample and fixed errors

7551455

Added deploy_model_custom_trained_model_sample.py

bfc2d99

Small tweaks

fcdef14

Fixed arguments

20b9e76

Removed explain args from custom training sample

fc11810

Removed comment about AutoML

f39c51f

Renamed samples

edb7062

Added note about explanations

e7d1896

Fixed test

655b17a

Fixed tests

348dae9

ivanmkc force-pushed the imkc--mbsdk-samples-milestone1 branch from d8c3d8a to 8d474d6 Compare April 30, 2021 18:31

Ran linter

4131edf

ivanmkc force-pushed the imkc--mbsdk-samples-milestone1 branch from 8d474d6 to 4131edf Compare April 30, 2021 18:39

ivanmkc merged commit ef4f6f8 into googleapis:master Apr 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Added deploy_model_with_dedicated_resources_sample, deploy_model_with_automatic_resources_sample, upload_model and get_model samples #337

feat: Added deploy_model_with_dedicated_resources_sample, deploy_model_with_automatic_resources_sample, upload_model and get_model samples #337

ivanmkc commented Apr 17, 2021 •

edited

snippet-bot bot commented Apr 17, 2021 •

edited

ivanmkc Apr 19, 2021

ivanmkc Apr 19, 2021

sasha-gitg Apr 21, 2021

ivanmkc Apr 21, 2021

sasha-gitg Apr 21, 2021

ivanmkc Apr 21, 2021

sasha-gitg Apr 21, 2021

ivanmkc Apr 21, 2021 •

edited

sasha-gitg Apr 21, 2021

sasha-gitg Apr 21, 2021

ivanmkc Apr 22, 2021 •

edited

sasha-gitg Apr 23, 2021

ivanmkc Apr 23, 2021

ivanmkc Apr 26, 2021


		model = aiplatform.Model(model_name=model_name)

		# AutoML models require a machine_type of None

feat: Added deploy_model_with_dedicated_resources_sample, deploy_model_with_automatic_resources_sample, upload_model and get_model samples #337

feat: Added deploy_model_with_dedicated_resources_sample, deploy_model_with_automatic_resources_sample, upload_model and get_model samples #337

Conversation

ivanmkc commented Apr 17, 2021 • edited

snippet-bot bot commented Apr 17, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivanmkc Apr 21, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivanmkc Apr 22, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivanmkc commented Apr 17, 2021 •

edited

snippet-bot bot commented Apr 17, 2021 •

edited

ivanmkc Apr 21, 2021 •

edited

ivanmkc Apr 22, 2021 •

edited