From 338e4b151814fa6647a45ff597e23562d2565b9c Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Wed, 20 Jul 2022 07:04:07 +0000 Subject: [PATCH 01/10] feat: Add samples for context list,get and create --- samples/model-builder/conftest.py | 31 +++++++++++ .../create_context_with_sdk_sample.py | 41 +++++++++++++++ .../create_context_with_sdk_sample_test.py | 51 +++++++++++++++++++ .../experiment_tracking/get_context_sample.py | 31 +++++++++++ .../get_context_sample_test.py | 33 ++++++++++++ .../list_context_sample.py | 31 +++++++++++ .../list_context_sample_test.py | 34 +++++++++++++ 7 files changed, 252 insertions(+) create mode 100644 samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py create mode 100644 samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py create mode 100644 samples/model-builder/experiment_tracking/get_context_sample.py create mode 100644 samples/model-builder/experiment_tracking/get_context_sample_test.py create mode 100644 samples/model-builder/experiment_tracking/list_context_sample.py create mode 100644 samples/model-builder/experiment_tracking/list_context_sample_test.py diff --git a/samples/model-builder/conftest.py b/samples/model-builder/conftest.py index 3e6e2a1c84..874776c2db 100644 --- a/samples/model-builder/conftest.py +++ b/samples/model-builder/conftest.py @@ -527,6 +527,12 @@ def mock_artifact(): yield mock +@pytest.fixture +def mock_context(): + mock = MagicMock(aiplatform.metadata.context.Context) + yield mock + + @pytest.fixture def mock_experiment(): mock = MagicMock(aiplatform.Experiment) @@ -590,6 +596,31 @@ def mock_get_artifact(mock_artifact): yield mock_get_artifact +@pytest.fixture +def mock_context_get(mock_context): + with patch.object(aiplatform.metadata.context.Context, "get") as mock_context_get: + mock_context_get.return_value = mock_context + yield mock_context_get + + +@pytest.fixture +def mock_context_list(mock_context): + with patch.object(aiplatform.metadata.context.Context, "list") as mock_context_list: + # Returning list of 2 contexts to avoid confusion with get method + # which returns one unique context. + mock_context_list.return_value = [mock_context, mock_context] + yield mock_context_list + + +@pytest.fixture +def mock_create_context(mock_context): + with patch.object( + aiplatform.metadata.context.Context, "create" + ) as mock_create_context: + mock_create_context.return_value = mock_context + yield mock_create_context + + @pytest.fixture def mock_pipeline_job_create(mock_pipeline_job): with patch.object(aiplatform, "PipelineJob") as mock_pipeline_job_create: diff --git a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py new file mode 100644 index 0000000000..388ed8db49 --- /dev/null +++ b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py @@ -0,0 +1,41 @@ +# Copyright 2022 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 +# +# https://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. + +from typing import Any, Dict, List, Optional + +from google.cloud import aiplatform +from google.cloud.aiplatform.metadata.schema.system import context_schema + + +# [START aiplatform_sdk_create_context_with_sdk_sample] +def create_context_sample( + display_name: str, + project: str, + location: str, + context_id: Optional[str] = None, + metadata: Optional[Dict[str, Any]] = None, + schema_version: Optional[str] = None, + description: Optional[str] = None, +): + aiplatform.init(project=project, location=location) + + return context_schema.Experiment( + display_name=display_name, + context_id=context_id, + metadata=metadata, + schema_version=schema_version, + description=description, + ).create() + +# [END aiplatform_sdk_create_context_with_sdk_sample] diff --git a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py new file mode 100644 index 0000000000..088422baef --- /dev/null +++ b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py @@ -0,0 +1,51 @@ +# Copyright 2022 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 +# +# https://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 create_context_with_sdk_sample + +from google.cloud.aiplatform.compat.types import context as gca_context + +import test_constants as constants + + +def test_create_context_sample( + mock_sdk_init, mock_create_context, mock_context, +): + exc = create_context_with_sdk_sample.create_context_sample( + display_name=constants.DISPLAY_NAME, + project=constants.PROJECT, + location=constants.LOCATION, + context_id=constants.RESOURCE_ID, + metadata=constants.METADATA, + schema_version=constants.SCHEMA_VERSION, + description=constants.DESCRIPTION, + ) + + mock_sdk_init.assert_called_with( + project=constants.PROJECT, location=constants.LOCATION, + ) + + mock_create_context.assert_called_with( + resource_id=constants.RESOURCE_ID, + schema_title="system.Experiment", + display_name=constants.DISPLAY_NAME, + schema_version=constants.SCHEMA_VERSION, + description=constants.DESCRIPTION, + metadata=constants.METADATA, + metadata_store_id="default", + project=None, + location=None, + credentials=None, + ) + assert exc is mock_context diff --git a/samples/model-builder/experiment_tracking/get_context_sample.py b/samples/model-builder/experiment_tracking/get_context_sample.py new file mode 100644 index 0000000000..31bd231e79 --- /dev/null +++ b/samples/model-builder/experiment_tracking/get_context_sample.py @@ -0,0 +1,31 @@ +# Copyright 2022 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 +# +# https://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. + +from google.cloud import aiplatform + + +# [START aiplatform_sdk_get_context_sample] +def get_context_sample( + context_id: str, + project: str, + location: str, +): + context = aiplatform.metadata.context.Context.get( + resource_id=context_id, project=project, location=location +) + + return context + + +# [END aiplatform_sdk_get_context_sample] diff --git a/samples/model-builder/experiment_tracking/get_context_sample_test.py b/samples/model-builder/experiment_tracking/get_context_sample_test.py new file mode 100644 index 0000000000..b077e29203 --- /dev/null +++ b/samples/model-builder/experiment_tracking/get_context_sample_test.py @@ -0,0 +1,33 @@ +# Copyright 2022 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 +# +# https://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 get_context_sample + +import test_constants + + +def test_get_context_sample(mock_context, mock_context_get): + context = get_context_sample.get_context_sample( + context_id=test_constants.RESOURCE_ID, + project=test_constants.PROJECT, + location=test_constants.LOCATION, + ) + + mock_context_get.assert_called_with( + resource_id=test_constants.RESOURCE_ID, + project=test_constants.PROJECT, + location=test_constants.LOCATION, + ) + + assert context is mock_context diff --git a/samples/model-builder/experiment_tracking/list_context_sample.py b/samples/model-builder/experiment_tracking/list_context_sample.py new file mode 100644 index 0000000000..374a83ae23 --- /dev/null +++ b/samples/model-builder/experiment_tracking/list_context_sample.py @@ -0,0 +1,31 @@ +# Copyright 2022 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 +# +# https://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. + +from google.cloud import aiplatform + + +# [START aiplatform_sdk_list_context_sample] +def list_context_sample( + context_id: str, + project: str, + location: str, +): + context = aiplatform.metadata.context.Context.list( + resource_id=context_id, project=project, location=location +) + + return context + + +# [END aiplatform_sdk_list_context_sample] diff --git a/samples/model-builder/experiment_tracking/list_context_sample_test.py b/samples/model-builder/experiment_tracking/list_context_sample_test.py new file mode 100644 index 0000000000..5e26b142e9 --- /dev/null +++ b/samples/model-builder/experiment_tracking/list_context_sample_test.py @@ -0,0 +1,34 @@ +# Copyright 2022 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 +# +# https://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 list_context_sample + +import test_constants + + +def test_list_context_sample(mock_context, mock_context_list): + context = list_context_sample.list_context_sample( + context_id=test_constants.RESOURCE_ID, + project=test_constants.PROJECT, + location=test_constants.LOCATION, + ) + + mock_context_list.assert_called_with( + resource_id=test_constants.RESOURCE_ID, + project=test_constants.PROJECT, + location=test_constants.LOCATION, + ) + + assert context[0] is mock_context + assert context[1] is mock_context \ No newline at end of file From 7a139a85347f46c4acbfe2055f85ee4225d63238 Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Wed, 20 Jul 2022 18:15:44 +0000 Subject: [PATCH 02/10] fix lint issues. --- .../experiment_tracking/create_context_with_sdk_sample.py | 2 +- .../experiment_tracking/create_context_with_sdk_sample_test.py | 2 -- .../model-builder/experiment_tracking/get_context_sample.py | 3 +-- .../model-builder/experiment_tracking/list_context_sample.py | 3 +-- .../experiment_tracking/list_context_sample_test.py | 2 +- 5 files changed, 4 insertions(+), 8 deletions(-) diff --git a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py index 388ed8db49..d688b14c46 100644 --- a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py +++ b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample.py @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -from typing import Any, Dict, List, Optional +from typing import Any, Dict, Optional from google.cloud import aiplatform from google.cloud.aiplatform.metadata.schema.system import context_schema diff --git a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py index 088422baef..0286b39ae3 100644 --- a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py +++ b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py @@ -14,8 +14,6 @@ import create_context_with_sdk_sample -from google.cloud.aiplatform.compat.types import context as gca_context - import test_constants as constants diff --git a/samples/model-builder/experiment_tracking/get_context_sample.py b/samples/model-builder/experiment_tracking/get_context_sample.py index 31bd231e79..883e1b521d 100644 --- a/samples/model-builder/experiment_tracking/get_context_sample.py +++ b/samples/model-builder/experiment_tracking/get_context_sample.py @@ -22,8 +22,7 @@ def get_context_sample( location: str, ): context = aiplatform.metadata.context.Context.get( - resource_id=context_id, project=project, location=location -) + resource_id=context_id, project=project, location=location) return context diff --git a/samples/model-builder/experiment_tracking/list_context_sample.py b/samples/model-builder/experiment_tracking/list_context_sample.py index 374a83ae23..31e67c9e24 100644 --- a/samples/model-builder/experiment_tracking/list_context_sample.py +++ b/samples/model-builder/experiment_tracking/list_context_sample.py @@ -22,8 +22,7 @@ def list_context_sample( location: str, ): context = aiplatform.metadata.context.Context.list( - resource_id=context_id, project=project, location=location -) + resource_id=context_id, project=project, location=location) return context diff --git a/samples/model-builder/experiment_tracking/list_context_sample_test.py b/samples/model-builder/experiment_tracking/list_context_sample_test.py index 5e26b142e9..46c020ea53 100644 --- a/samples/model-builder/experiment_tracking/list_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/list_context_sample_test.py @@ -31,4 +31,4 @@ def test_list_context_sample(mock_context, mock_context_list): ) assert context[0] is mock_context - assert context[1] is mock_context \ No newline at end of file + assert context[1] is mock_context From 41a21d5e6429457b6983a3931a178c7c0704e4e5 Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Wed, 20 Jul 2022 23:23:00 +0000 Subject: [PATCH 03/10] Change import path to aiplatform.Context --- samples/model-builder/conftest.py | 10 ++++------ .../experiment_tracking/get_context_sample.py | 4 ++-- .../experiment_tracking/list_context_sample.py | 4 ++-- 3 files changed, 8 insertions(+), 10 deletions(-) diff --git a/samples/model-builder/conftest.py b/samples/model-builder/conftest.py index 874776c2db..c3269a0326 100644 --- a/samples/model-builder/conftest.py +++ b/samples/model-builder/conftest.py @@ -529,7 +529,7 @@ def mock_artifact(): @pytest.fixture def mock_context(): - mock = MagicMock(aiplatform.metadata.context.Context) + mock = MagicMock(aiplatform.Context) yield mock @@ -598,14 +598,14 @@ def mock_get_artifact(mock_artifact): @pytest.fixture def mock_context_get(mock_context): - with patch.object(aiplatform.metadata.context.Context, "get") as mock_context_get: + with patch.object(aiplatform.Context, "get") as mock_context_get: mock_context_get.return_value = mock_context yield mock_context_get @pytest.fixture def mock_context_list(mock_context): - with patch.object(aiplatform.metadata.context.Context, "list") as mock_context_list: + with patch.object(aiplatform.Context, "list") as mock_context_list: # Returning list of 2 contexts to avoid confusion with get method # which returns one unique context. mock_context_list.return_value = [mock_context, mock_context] @@ -614,9 +614,7 @@ def mock_context_list(mock_context): @pytest.fixture def mock_create_context(mock_context): - with patch.object( - aiplatform.metadata.context.Context, "create" - ) as mock_create_context: + with patch.object(aiplatform.Context, "create") as mock_create_context: mock_create_context.return_value = mock_context yield mock_create_context diff --git a/samples/model-builder/experiment_tracking/get_context_sample.py b/samples/model-builder/experiment_tracking/get_context_sample.py index 883e1b521d..0ce08e75f2 100644 --- a/samples/model-builder/experiment_tracking/get_context_sample.py +++ b/samples/model-builder/experiment_tracking/get_context_sample.py @@ -21,8 +21,8 @@ def get_context_sample( project: str, location: str, ): - context = aiplatform.metadata.context.Context.get( - resource_id=context_id, project=project, location=location) + context = aiplatform.Context.get( + resource_id=context_id, project=project, location=location) return context diff --git a/samples/model-builder/experiment_tracking/list_context_sample.py b/samples/model-builder/experiment_tracking/list_context_sample.py index 31e67c9e24..15400512dc 100644 --- a/samples/model-builder/experiment_tracking/list_context_sample.py +++ b/samples/model-builder/experiment_tracking/list_context_sample.py @@ -21,8 +21,8 @@ def list_context_sample( project: str, location: str, ): - context = aiplatform.metadata.context.Context.list( - resource_id=context_id, project=project, location=location) + context = aiplatform.Context.list( + resource_id=context_id, project=project, location=location) return context From ef23369a4e2bc206397c9b472769ddf5b92c00e0 Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Fri, 22 Jul 2022 18:33:04 +0000 Subject: [PATCH 04/10] Fix create mock. --- samples/model-builder/conftest.py | 10 ++++++---- .../create_context_with_sdk_sample_test.py | 15 ++------------- 2 files changed, 8 insertions(+), 17 deletions(-) diff --git a/samples/model-builder/conftest.py b/samples/model-builder/conftest.py index babd2a69eb..7c31e47deb 100644 --- a/samples/model-builder/conftest.py +++ b/samples/model-builder/conftest.py @@ -629,10 +629,12 @@ def mock_context_list(mock_context): @pytest.fixture -def mock_create_context(mock_context): - with patch.object(aiplatform.Context, "create") as mock_create_context: - mock_create_context.return_value = mock_context - yield mock_create_context +def mock_create_schema_base_context(mock_context): + with patch.object( + aiplatform.metadata.schema.base_context.BaseContextSchema, "create" + ) as mock_create_schema_base_context: + mock_create_schema_base_context.return_value = mock_context + yield mock_create_schema_base_context @pytest.fixture diff --git a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py index 0286b39ae3..b04fc7c69a 100644 --- a/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py +++ b/samples/model-builder/experiment_tracking/create_context_with_sdk_sample_test.py @@ -18,7 +18,7 @@ def test_create_context_sample( - mock_sdk_init, mock_create_context, mock_context, + mock_sdk_init, mock_create_schema_base_context, mock_context, ): exc = create_context_with_sdk_sample.create_context_sample( display_name=constants.DISPLAY_NAME, @@ -34,16 +34,5 @@ def test_create_context_sample( project=constants.PROJECT, location=constants.LOCATION, ) - mock_create_context.assert_called_with( - resource_id=constants.RESOURCE_ID, - schema_title="system.Experiment", - display_name=constants.DISPLAY_NAME, - schema_version=constants.SCHEMA_VERSION, - description=constants.DESCRIPTION, - metadata=constants.METADATA, - metadata_store_id="default", - project=None, - location=None, - credentials=None, - ) + mock_create_schema_base_context.assert_called_with() assert exc is mock_context From 5a4093c874800ed9fddf8094af857f350336020b Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Fri, 22 Jul 2022 22:33:42 +0000 Subject: [PATCH 05/10] remove duplicate mock method --- samples/model-builder/conftest.py | 7 ------- 1 file changed, 7 deletions(-) diff --git a/samples/model-builder/conftest.py b/samples/model-builder/conftest.py index 4d56742208..3c5960a2b1 100644 --- a/samples/model-builder/conftest.py +++ b/samples/model-builder/conftest.py @@ -644,13 +644,6 @@ def mock_artifact_get(mock_artifact): yield mock_artifact_get -@pytest.fixture -def mock_context_get(mock_context): - with patch.object(aiplatform.Context, "get") as mock_context_get: - mock_context_get.return_value = mock_context - yield mock_context_get - - @pytest.fixture def mock_pipeline_job_create(mock_pipeline_job): with patch.object(aiplatform, "PipelineJob") as mock_pipeline_job_create: From 32fba4fe65c819b446126e710c171ff13c76f652 Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Mon, 25 Jul 2022 10:29:20 -0700 Subject: [PATCH 06/10] Update samples/model-builder/experiment_tracking/get_context_sample_test.py Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com> --- .../experiment_tracking/get_context_sample_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/model-builder/experiment_tracking/get_context_sample_test.py b/samples/model-builder/experiment_tracking/get_context_sample_test.py index b077e29203..aaae1bb19d 100644 --- a/samples/model-builder/experiment_tracking/get_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/get_context_sample_test.py @@ -22,7 +22,7 @@ def test_get_context_sample(mock_context, mock_context_get): context_id=test_constants.RESOURCE_ID, project=test_constants.PROJECT, location=test_constants.LOCATION, - ) + ) mock_context_get.assert_called_with( resource_id=test_constants.RESOURCE_ID, From 854430783e979e3dee13611691c185c723d80376 Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Mon, 25 Jul 2022 10:29:26 -0700 Subject: [PATCH 07/10] Update samples/model-builder/experiment_tracking/list_context_sample_test.py Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com> --- .../experiment_tracking/list_context_sample_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/model-builder/experiment_tracking/list_context_sample_test.py b/samples/model-builder/experiment_tracking/list_context_sample_test.py index 46c020ea53..475e51d2c0 100644 --- a/samples/model-builder/experiment_tracking/list_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/list_context_sample_test.py @@ -22,7 +22,7 @@ def test_list_context_sample(mock_context, mock_context_list): context_id=test_constants.RESOURCE_ID, project=test_constants.PROJECT, location=test_constants.LOCATION, - ) + ) mock_context_list.assert_called_with( resource_id=test_constants.RESOURCE_ID, From 7066313be48c93b3ef26b3a6912d3ca8fdd6508b Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Mon, 25 Jul 2022 10:29:34 -0700 Subject: [PATCH 08/10] Update samples/model-builder/experiment_tracking/list_context_sample_test.py Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com> --- .../experiment_tracking/list_context_sample_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/model-builder/experiment_tracking/list_context_sample_test.py b/samples/model-builder/experiment_tracking/list_context_sample_test.py index 475e51d2c0..ea0d2c7a01 100644 --- a/samples/model-builder/experiment_tracking/list_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/list_context_sample_test.py @@ -28,7 +28,7 @@ def test_list_context_sample(mock_context, mock_context_list): resource_id=test_constants.RESOURCE_ID, project=test_constants.PROJECT, location=test_constants.LOCATION, - ) + ) assert context[0] is mock_context assert context[1] is mock_context From 47620a146f4bc4f47fa5e17a01e6fdc6d9defbe3 Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Mon, 25 Jul 2022 12:40:50 -0700 Subject: [PATCH 09/10] Update samples/model-builder/experiment_tracking/get_context_sample_test.py Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com> --- .../experiment_tracking/get_context_sample_test.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/model-builder/experiment_tracking/get_context_sample_test.py b/samples/model-builder/experiment_tracking/get_context_sample_test.py index aaae1bb19d..0aa68b6b04 100644 --- a/samples/model-builder/experiment_tracking/get_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/get_context_sample_test.py @@ -28,6 +28,6 @@ def test_get_context_sample(mock_context, mock_context_get): resource_id=test_constants.RESOURCE_ID, project=test_constants.PROJECT, location=test_constants.LOCATION, - ) + ) assert context is mock_context From 3c461b11002a305e50c1e69b46321586b96f3e5b Mon Sep 17 00:00:00 2001 From: sina chavoshi Date: Mon, 25 Jul 2022 20:00:43 +0000 Subject: [PATCH 10/10] update formatting and comments based on review feedback --- .../create_artifact_sample.py | 2 -- .../create_artifact_with_sdk_sample.py | 2 -- .../create_execution_with_sdk_sample.py | 1 - .../delete_artifact_sample_test.py | 14 +++++------ .../delete_context_sample_test.py | 14 +++++------ .../delete_execution_sample_test.py | 14 +++++------ .../get_artifact_sample.py | 1 - .../get_artifact_sample_test.py | 14 +++++------ .../get_artifact_with_uri_sample.py | 2 -- .../experiment_tracking/get_context_sample.py | 2 -- .../get_context_sample_test.py | 14 +++++------ .../get_execution_sample_test.py | 12 +++++----- .../list_artifact_sample.py | 2 -- .../list_artifact_sample_test.py | 2 ++ .../list_context_sample.py | 2 -- .../list_context_sample_test.py | 24 ++++++++++--------- .../list_execution_sample_test.py | 2 ++ 17 files changed, 58 insertions(+), 66 deletions(-) diff --git a/samples/model-builder/experiment_tracking/create_artifact_sample.py b/samples/model-builder/experiment_tracking/create_artifact_sample.py index 90a7432bea..1f3b7fdffd 100644 --- a/samples/model-builder/experiment_tracking/create_artifact_sample.py +++ b/samples/model-builder/experiment_tracking/create_artifact_sample.py @@ -40,8 +40,6 @@ def create_artifact_sample( project=project, location=location, ) - return artifact - # [END aiplatform_sdk_create_artifact_sample] diff --git a/samples/model-builder/experiment_tracking/create_artifact_with_sdk_sample.py b/samples/model-builder/experiment_tracking/create_artifact_with_sdk_sample.py index 3d67cacc17..ed8315a617 100644 --- a/samples/model-builder/experiment_tracking/create_artifact_with_sdk_sample.py +++ b/samples/model-builder/experiment_tracking/create_artifact_with_sdk_sample.py @@ -36,8 +36,6 @@ def create_artifact_sample( description=description, metadata=metadata, ) - return system_artifact_schema.create(project=project, location=location,) - # [END aiplatform_sdk_create_artifact_with_sdk_sample] diff --git a/samples/model-builder/experiment_tracking/create_execution_with_sdk_sample.py b/samples/model-builder/experiment_tracking/create_execution_with_sdk_sample.py index ac0faa7065..c364fc732f 100644 --- a/samples/model-builder/experiment_tracking/create_execution_with_sdk_sample.py +++ b/samples/model-builder/experiment_tracking/create_execution_with_sdk_sample.py @@ -43,5 +43,4 @@ def create_execution_sample( execution.assign_output_artifacts(output_artifacts) return execution - # [END aiplatform_sdk_create_execution_with_sdk_sample] diff --git a/samples/model-builder/experiment_tracking/delete_artifact_sample_test.py b/samples/model-builder/experiment_tracking/delete_artifact_sample_test.py index 555b6745ee..bd5aefc102 100644 --- a/samples/model-builder/experiment_tracking/delete_artifact_sample_test.py +++ b/samples/model-builder/experiment_tracking/delete_artifact_sample_test.py @@ -14,18 +14,18 @@ import delete_artifact_sample -import test_constants +import test_constants as constants def test_delete_artifact_sample(mock_artifact, mock_artifact_get): delete_artifact_sample.delete_artifact_sample( - artifact_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + artifact_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) mock_artifact_get.assert_called_with( - resource_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + resource_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) diff --git a/samples/model-builder/experiment_tracking/delete_context_sample_test.py b/samples/model-builder/experiment_tracking/delete_context_sample_test.py index 49e2a08c72..6b60acd4c8 100644 --- a/samples/model-builder/experiment_tracking/delete_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/delete_context_sample_test.py @@ -14,18 +14,18 @@ import delete_context_sample -import test_constants +import test_constants as constants def test_delete_context_sample(mock_context_get): delete_context_sample.delete_context_sample( - context_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + context_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) mock_context_get.assert_called_with( - resource_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + resource_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) diff --git a/samples/model-builder/experiment_tracking/delete_execution_sample_test.py b/samples/model-builder/experiment_tracking/delete_execution_sample_test.py index 3e6cba5d8e..f5fa850fc6 100644 --- a/samples/model-builder/experiment_tracking/delete_execution_sample_test.py +++ b/samples/model-builder/experiment_tracking/delete_execution_sample_test.py @@ -14,18 +14,18 @@ import delete_execution_sample -import test_constants +import test_constants as constants def test_delete_execution_sample(mock_execution, mock_execution_get): delete_execution_sample.delete_execution_sample( - execution_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + execution_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) mock_execution_get.assert_called_with( - resource_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + resource_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) diff --git a/samples/model-builder/experiment_tracking/get_artifact_sample.py b/samples/model-builder/experiment_tracking/get_artifact_sample.py index 93ea031b2c..bfc55f994c 100644 --- a/samples/model-builder/experiment_tracking/get_artifact_sample.py +++ b/samples/model-builder/experiment_tracking/get_artifact_sample.py @@ -27,5 +27,4 @@ def get_artifact_sample( return artifact - # [END aiplatform_sdk_get_artifact_sample] diff --git a/samples/model-builder/experiment_tracking/get_artifact_sample_test.py b/samples/model-builder/experiment_tracking/get_artifact_sample_test.py index 21047e4e7d..f32c9e5fec 100644 --- a/samples/model-builder/experiment_tracking/get_artifact_sample_test.py +++ b/samples/model-builder/experiment_tracking/get_artifact_sample_test.py @@ -14,20 +14,20 @@ import get_artifact_sample -import test_constants +import test_constants as constants def test_get_artifact_sample(mock_artifact, mock_artifact_get): artifact = get_artifact_sample.get_artifact_sample( - artifact_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + artifact_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) mock_artifact_get.assert_called_with( - resource_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + resource_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) assert artifact is mock_artifact diff --git a/samples/model-builder/experiment_tracking/get_artifact_with_uri_sample.py b/samples/model-builder/experiment_tracking/get_artifact_with_uri_sample.py index 6c3f11c9ca..92fa56c841 100644 --- a/samples/model-builder/experiment_tracking/get_artifact_with_uri_sample.py +++ b/samples/model-builder/experiment_tracking/get_artifact_with_uri_sample.py @@ -24,8 +24,6 @@ def get_artifact_with_uri_sample( artifact = aiplatform.Artifact.get_with_uri( uri=uri, project=project, location=location ) - return artifact - # [END aiplatform_sdk_get_artifact_with_uri_sample] diff --git a/samples/model-builder/experiment_tracking/get_context_sample.py b/samples/model-builder/experiment_tracking/get_context_sample.py index 0ce08e75f2..8cd62e78ea 100644 --- a/samples/model-builder/experiment_tracking/get_context_sample.py +++ b/samples/model-builder/experiment_tracking/get_context_sample.py @@ -23,8 +23,6 @@ def get_context_sample( ): context = aiplatform.Context.get( resource_id=context_id, project=project, location=location) - return context - # [END aiplatform_sdk_get_context_sample] diff --git a/samples/model-builder/experiment_tracking/get_context_sample_test.py b/samples/model-builder/experiment_tracking/get_context_sample_test.py index 0aa68b6b04..155a8eb032 100644 --- a/samples/model-builder/experiment_tracking/get_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/get_context_sample_test.py @@ -14,20 +14,20 @@ import get_context_sample -import test_constants +import test_constants as constants def test_get_context_sample(mock_context, mock_context_get): context = get_context_sample.get_context_sample( - context_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + context_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) mock_context_get.assert_called_with( - resource_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + resource_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) assert context is mock_context diff --git a/samples/model-builder/experiment_tracking/get_execution_sample_test.py b/samples/model-builder/experiment_tracking/get_execution_sample_test.py index 21047e4e7d..583c27859a 100644 --- a/samples/model-builder/experiment_tracking/get_execution_sample_test.py +++ b/samples/model-builder/experiment_tracking/get_execution_sample_test.py @@ -12,22 +12,22 @@ # See the License for the specific language governing permissions and # limitations under the License. -import get_artifact_sample +import get_execution_sample import test_constants -def test_get_artifact_sample(mock_artifact, mock_artifact_get): - artifact = get_artifact_sample.get_artifact_sample( - artifact_id=test_constants.RESOURCE_ID, +def test_get_execution_sample(mock_execution, mock_execution_get): + execution = get_execution_sample.get_execution_sample( + execution_id=test_constants.RESOURCE_ID, project=test_constants.PROJECT, location=test_constants.LOCATION, ) - mock_artifact_get.assert_called_with( + mock_execution_get.assert_called_with( resource_id=test_constants.RESOURCE_ID, project=test_constants.PROJECT, location=test_constants.LOCATION, ) - assert artifact is mock_artifact + assert execution is mock_execution diff --git a/samples/model-builder/experiment_tracking/list_artifact_sample.py b/samples/model-builder/experiment_tracking/list_artifact_sample.py index ac0f15d9f3..55f9419b32 100644 --- a/samples/model-builder/experiment_tracking/list_artifact_sample.py +++ b/samples/model-builder/experiment_tracking/list_artifact_sample.py @@ -29,8 +29,6 @@ def list_artifact_sample( location=location) combined_filters = f"{display_name_fitler} AND {create_date_filter}" - return aiplatform.Artifact.list(filter=combined_filters) - # [END aiplatform_sdk_create_artifact_with_sdk_sample] diff --git a/samples/model-builder/experiment_tracking/list_artifact_sample_test.py b/samples/model-builder/experiment_tracking/list_artifact_sample_test.py index 2df444b76c..5eaf9993e6 100644 --- a/samples/model-builder/experiment_tracking/list_artifact_sample_test.py +++ b/samples/model-builder/experiment_tracking/list_artifact_sample_test.py @@ -29,5 +29,7 @@ def test_list_artifact_with_sdk_sample(mock_artifact, mock_list_artifact): filter=f"{constants.DISPLAY_NAME} AND {constants.CREATE_DATE}" ) assert len(artifacts) == 2 + # Returning list of 2 context to avoid confusion with get method + # which returns one unique context. assert artifacts[0] is mock_artifact assert artifacts[1] is mock_artifact diff --git a/samples/model-builder/experiment_tracking/list_context_sample.py b/samples/model-builder/experiment_tracking/list_context_sample.py index 15400512dc..de07bf51cf 100644 --- a/samples/model-builder/experiment_tracking/list_context_sample.py +++ b/samples/model-builder/experiment_tracking/list_context_sample.py @@ -23,8 +23,6 @@ def list_context_sample( ): context = aiplatform.Context.list( resource_id=context_id, project=project, location=location) - return context - # [END aiplatform_sdk_list_context_sample] diff --git a/samples/model-builder/experiment_tracking/list_context_sample_test.py b/samples/model-builder/experiment_tracking/list_context_sample_test.py index ea0d2c7a01..d09ce346fe 100644 --- a/samples/model-builder/experiment_tracking/list_context_sample_test.py +++ b/samples/model-builder/experiment_tracking/list_context_sample_test.py @@ -14,21 +14,23 @@ import list_context_sample -import test_constants +import test_constants as constants def test_list_context_sample(mock_context, mock_context_list): - context = list_context_sample.list_context_sample( - context_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + contexts = list_context_sample.list_context_sample( + context_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) mock_context_list.assert_called_with( - resource_id=test_constants.RESOURCE_ID, - project=test_constants.PROJECT, - location=test_constants.LOCATION, + resource_id=constants.RESOURCE_ID, + project=constants.PROJECT, + location=constants.LOCATION, ) - - assert context[0] is mock_context - assert context[1] is mock_context + assert len(contexts) == 2 + # Returning list of 2 context to avoid confusion with get method + # which returns one unique context. + assert contexts[0] is mock_context + assert contexts[1] is mock_context diff --git a/samples/model-builder/experiment_tracking/list_execution_sample_test.py b/samples/model-builder/experiment_tracking/list_execution_sample_test.py index ac53744d1b..cad29a11a4 100644 --- a/samples/model-builder/experiment_tracking/list_execution_sample_test.py +++ b/samples/model-builder/experiment_tracking/list_execution_sample_test.py @@ -29,5 +29,7 @@ def test_list_execution_sample(mock_execution, mock_list_execution): filter=f"{constants.DISPLAY_NAME} AND {constants.CREATE_DATE}" ) assert len(executions) == 2 + # Returning list of 2 executions to avoid confusion with get method + # which returns one unique execution. assert executions[0] is mock_execution assert executions[1] is mock_execution