feat: component with default label

Azure · Oct 19, 2022 · 6f025e6 · 6f025e6
1 parent 86a6d37
commit 6f025e6
Show file tree

Hide file tree

Showing 5 changed files with 716 additions and 9 deletions.
diff --git a/sdk/ml/azure-ai-ml/azure/ai/ml/constants/_common.py b/sdk/ml/azure-ai-ml/azure/ai/ml/constants/_common.py
@@ -132,6 +132,8 @@
     "AzureFile": "https://{}.file.{}",
 }
 
+DEFAULT_LABEL_NAME = "default"
+DEFAULT_COMPONENT_VERSION = "azureml_default"
 ANONYMOUS_COMPONENT_NAME = "azureml_anonymous"
 GIT_PATH_PREFIX = "git+"
 SCHEMA_VALIDATION_ERROR_TEMPLATE = (

diff --git a/sdk/ml/azure-ai-ml/azure/ai/ml/operations/_component_operations.py b/sdk/ml/azure-ai-ml/azure/ai/ml/operations/_component_operations.py
@@ -30,7 +30,8 @@
 from azure.ai.ml._utils._azureml_polling import AzureMLPolling
 from azure.ai.ml._utils._endpoint_utils import polling_wait
 from azure.ai.ml._utils._logger_utils import OpsLogger
-from azure.ai.ml.constants._common import AzureMLResourceType, LROConfigurations
+from azure.ai.ml.constants._common import AzureMLResourceType, LROConfigurations, DEFAULT_LABEL_NAME, \
+    DEFAULT_COMPONENT_VERSION
 from azure.ai.ml.entities import Component, ValidationResult
 from azure.ai.ml.entities._assets import Code
 from azure.ai.ml.exceptions import ComponentException, ErrorCategory, ErrorTarget, ValidationException
@@ -172,17 +173,16 @@ def get(self, name: str, version: Optional[str] = None, label: Optional[str] = N
                 error_category=ErrorCategory.USER_ERROR,
             )
 
+        if not version and not label:
+            label = DEFAULT_LABEL_NAME
+
+        if label == DEFAULT_LABEL_NAME:
+            label = None
+            version = DEFAULT_COMPONENT_VERSION
+
         if label:
             return _resolve_label_to_asset(self, name, label)
 
-        if not version:
-            msg = "Must provide either version or label."
-            raise ValidationException(
-                message=msg,
-                target=ErrorTarget.COMPONENT,
-                no_personal_data_message=msg,
-                error_category=ErrorCategory.USER_ERROR,
-            )
         result = (
             self._version_operation.get(
                 name=name,

diff --git a/sdk/ml/azure-ai-ml/tests/component/e2etests/test_component.py b/sdk/ml/azure-ai-ml/tests/component/e2etests/test_component.py
@@ -850,3 +850,28 @@ def test_create_pipeline_component_from_job(self, client: MLClient, randstr: Cal
         component = PipelineComponent(name=name, source_job_id=job.id)
         rest_component = client.components.create_or_update(component)
         assert rest_component.name == name
+
+    def test_component_with_default_label(
+        self,
+        client: MLClient,
+        randstr: Callable[[str], str],
+    ) -> None:
+        yaml_path: str = "./tests/test_configs/components/helloworld_component.yml"
+        component_name = randstr("component_name")
+
+        create_component(client, component_name, path=yaml_path)
+
+        target_component = client.components.get(component_name, label="latest")
+
+        for default_component in [
+            client.components.get(component_name),
+            client.components.get(component_name, label="default"),
+        ]:
+            expected_component_dict = target_component._to_dict()
+            default_component_dict = default_component._to_dict()
+            assert pydash.omit(default_component_dict, "id") == pydash.omit(expected_component_dict, "id")
+
+            assert default_component.id.endswith(f"/components/{component_name}/labels/default")
+
+            node = default_component()
+            assert node._to_rest_object()["componentId"] == default_component.id
diff --git a/sdk/ml/azure-ai-ml/tests/component/unittests/test_component_operations.py b/sdk/ml/azure-ai-ml/tests/component/unittests/test_component_operations.py
@@ -110,6 +110,15 @@ def test_get(self, mock_component_operation: ComponentOperations) -> None:
         assert "version='1'" in create_call_args_str
         mock_component_entity._from_rest_object.assert_called_once()
 
+    def test_get_default(self, mock_component_operation: ComponentOperations) -> None:
+        with patch("azure.ai.ml.operations._component_operations.Component") as mock_component_entity:
+            mock_component_operation.get("mock_component")
+
+        mock_component_operation._version_operation.get.assert_called_once()
+        create_call_args_str = str(mock_component_operation._version_operation.get.call_args)
+        assert "name='mock_component'" in create_call_args_str
+        mock_component_entity._from_rest_object.assert_called_once()
+
     def test_archive_version(self, mock_component_operation: ComponentOperations):
         name = "random_name"
         component = Mock(ComponentVersionData(properties=Mock(ComponentVersionDetails())))