Rename job_service_type -> type (Azure#29603)

* job_service_type -> type

* add changelog entry

* fix broken type ref

* fix rest object serialization

* pylint

* run black

* fix pylint

Author: needuv

sdk/ml/azure-ai-ml/CHANGELOG.md

@@ -13,9 +13,13 @@
 - Fixed issue of spark input/output mode validation doesn't take effect because of wrong type assertion
 - Fixed the bug when setting `node.limits.timeout` to a pipeline input.
 
+### Breaking Changes
+
+- Renamed `JobServiceBase.job_service_type` to `type`
+
 ### Other Changes
 
-- 
+-
 
 ## 1.5.0 (2023-03-20)
 

sdk/ml/azure-ai-ml/azure/ai/ml/_schema/job/services.py

@@ -34,7 +34,7 @@ class JobServiceSchema(JobServiceBaseSchema):
     """This is to support tansformation of job services passed as dict type and internal job services like Custom,
     Tracking, Studio set by the system."""
 
-    job_service_type = UnionField(
+    type = UnionField(
         [
             StringTransformedEnum(
                 allowed_values=JobServiceTypeNames.NAMES_ALLOWED_FOR_PUBLIC,
@@ -46,55 +46,55 @@ class JobServiceSchema(JobServiceBaseSchema):
 
     @post_load
     def make(self, data, **kwargs):  # pylint: disable=unused-argument,no-self-use
-        data.pop("job_service_type", None)
+        data.pop("type", None)
         return JobService(**data)
 
 
 class TensorBoardJobServiceSchema(JobServiceBaseSchema):
-    job_service_type = StringTransformedEnum(
+    type = StringTransformedEnum(
         allowed_values=JobServiceTypeNames.EntityNames.TENSOR_BOARD,
         pass_original=True,
     )
     log_dir = fields.Str()
 
     @post_load
     def make(self, data, **kwargs):  # pylint: disable=unused-argument,no-self-use
-        data.pop("job_service_type", None)
+        data.pop("type", None)
         return TensorBoardJobService(**data)
 
 
 class SshJobServiceSchema(JobServiceBaseSchema):
-    job_service_type = StringTransformedEnum(
+    type = StringTransformedEnum(
         allowed_values=JobServiceTypeNames.EntityNames.SSH,
         pass_original=True,
     )
     ssh_public_keys = fields.Str()
 
     @post_load
     def make(self, data, **kwargs):  # pylint: disable=unused-argument,no-self-use
-        data.pop("job_service_type", None)
+        data.pop("type", None)
         return SshJobService(**data)
 
 
 class VsCodeJobServiceSchema(JobServiceBaseSchema):
-    job_service_type = StringTransformedEnum(
+    type = StringTransformedEnum(
         allowed_values=JobServiceTypeNames.EntityNames.VS_CODE,
         pass_original=True,
     )
 
     @post_load
     def make(self, data, **kwargs):  # pylint: disable=unused-argument,no-self-use
-        data.pop("job_service_type", None)
+        data.pop("type", None)
         return VsCodeJobService(**data)
 
 
 class JupyterLabJobServiceSchema(JobServiceBaseSchema):
-    job_service_type = StringTransformedEnum(
+    type = StringTransformedEnum(
         allowed_values=JobServiceTypeNames.EntityNames.JUPYTER_LAB,
         pass_original=True,
     )
 
     @post_load
     def make(self, data, **kwargs):  # pylint: disable=unused-argument,no-self-use
-        data.pop("job_service_type", None)
+        data.pop("type", None)
         return JupyterLabJobService(**data)

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/job_service.py

@@ -25,8 +25,8 @@ class JobServiceBase(RestTranslatableMixin, DictMixin):
     :type endpoint: str
     :param error_message: Any error in the service.
     :type error_message: str
-    :param job_service_type: Endpoint type.
-    :type job_service_type: str
+    :param type: Endpoint type.
+    :type type: str
     :param port: Port for endpoint.
     :type nodes: str
     :param nodes: Indicates whether the service has to run in all nodes.
@@ -43,21 +43,23 @@ def __init__(
         self,
         *,
         endpoint: Optional[str] = None,
-        job_service_type: Optional[Literal["jupyter_lab", "ssh", "tensor_board", "vs_code"]] = None,
+        type: Optional[  # pylint: disable=redefined-builtin
+            Literal["jupyter_lab", "ssh", "tensor_board", "vs_code"]
+        ] = None,
         nodes: Optional[Literal["all"]] = None,
         status: Optional[str] = None,
         port: Optional[int] = None,
         properties: Optional[Dict[str, str]] = None,
         **kwargs,  # pylint: disable=unused-argument
     ):
         self.endpoint = endpoint
-        self.job_service_type = job_service_type
+        self.type = type
         self.nodes = nodes
         self.status = status
         self.port = port
         self.properties = properties
         self._validate_nodes()
-        self._validate_job_service_type_name()
+        self._validate_type_name()
 
     def _validate_nodes(self):
         if not self.nodes in ["all", None]:
@@ -70,11 +72,10 @@ def _validate_nodes(self):
                 error_type=ValidationErrorType.INVALID_VALUE,
             )
 
-    def _validate_job_service_type_name(self):
-        if self.job_service_type and not self.job_service_type in JobServiceTypeNames.ENTITY_TO_REST.keys():
+    def _validate_type_name(self):
+        if self.type and not self.type in JobServiceTypeNames.ENTITY_TO_REST.keys():
             msg = (
-                f"job_service_type should be one of "
-                f"{JobServiceTypeNames.NAMES_ALLOWED_FOR_PUBLIC}, but received '{self.job_service_type}'."
+                f"type should be one of " f"{JobServiceTypeNames.NAMES_ALLOWED_FOR_PUBLIC}, but received '{self.type}'."
             )
             raise ValidationException(
                 message=msg,
@@ -87,9 +88,7 @@ def _validate_job_service_type_name(self):
     def _to_rest_job_service(self, updated_properties: Dict[str, str] = None) -> RestJobService:
         return RestJobService(
             endpoint=self.endpoint,
-            job_service_type=JobServiceTypeNames.ENTITY_TO_REST.get(self.job_service_type, None)
-            if self.job_service_type
-            else None,
+            job_service_type=JobServiceTypeNames.ENTITY_TO_REST.get(self.type, None) if self.type else None,
             nodes=AllNodes() if self.nodes else None,
             status=self.status,
             port=self.port,
@@ -113,9 +112,7 @@ def _to_rest_job_services(
     def _from_rest_job_service_object(cls, obj: RestJobService):
         return cls(
             endpoint=obj.endpoint,
-            job_service_type=JobServiceTypeNames.REST_TO_ENTITY.get(obj.job_service_type, None)
-            if obj.job_service_type
-            else None,
+            type=JobServiceTypeNames.REST_TO_ENTITY.get(obj.job_service_type, None) if obj.job_service_type else None,
             nodes="all" if obj.nodes else None,
             status=obj.status,
             port=obj.port,
@@ -155,9 +152,9 @@ class JobService(JobServiceBase):
 
     :param endpoint: Url for endpoint.
     :type endpoint: str
-    :param job_service_type: Endpoint type.
+    :param type: Endpoint type.
         Accepts "jupyter_lab", "ssh", "tensor_board", "vs_code"
-    :type job_service_type: str
+    :type type: str
     :param port: Port for endpoint.
     :type nodes: str
     :param nodes: Indicates whether the service has to run in all nodes.
@@ -196,7 +193,7 @@ class SshJobService(JobServiceBase):
     :type ssh_public_keys: str
     :param kwargs: A dictionary of additional configuration parameters.
     :type kwargs: dict
-    :ivar job_service_type: Specifies the type of job service. Set automatically to "ssh" for this class.
+    :ivar type: Specifies the type of job service. Set automatically to "ssh" for this class.
     :vartype type: str
     """
 
@@ -219,7 +216,7 @@ def __init__(
             properties=properties,
             **kwargs,
         )
-        self.job_service_type = JobServiceTypeNames.EntityNames.SSH
+        self.type = JobServiceTypeNames.EntityNames.SSH
         self.ssh_public_keys = ssh_public_keys
 
     @classmethod
@@ -251,7 +248,7 @@ class TensorBoardJobService(JobServiceBase):
     :type log_dir: str
     :param kwargs: A dictionary of additional configuration parameters.
     :type kwargs: dict
-    :ivar job_service_type: Specifies the type of job service. Set automatically to "tensor_board" for this class.
+    :ivar type: Specifies the type of job service. Set automatically to "tensor_board" for this class.
     :vartype type: str
     """
 
@@ -274,7 +271,7 @@ def __init__(
             properties=properties,
             **kwargs,
         )
-        self.job_service_type = JobServiceTypeNames.EntityNames.TENSOR_BOARD
+        self.type = JobServiceTypeNames.EntityNames.TENSOR_BOARD
         self.log_dir = log_dir
 
     @classmethod
@@ -304,7 +301,7 @@ class JupyterLabJobService(JobServiceBase):
     :type status: str
     :param kwargs: A dictionary of additional configuration parameters.
     :type kwargs: dict
-    :ivar job_service_type: Specifies the type of job service. Set automatically to "jupyter_lab" for this class.
+    :ivar type: Specifies the type of job service. Set automatically to "jupyter_lab" for this class.
     :vartype type: str
     """
 
@@ -326,7 +323,7 @@ def __init__(
             properties=properties,
             **kwargs,
         )
-        self.job_service_type = JobServiceTypeNames.EntityNames.JUPYTER_LAB
+        self.type = JobServiceTypeNames.EntityNames.JUPYTER_LAB
 
     @classmethod
     def _from_rest_object(cls, obj: RestJobService) -> "JupyterLabJobService":
@@ -352,7 +349,7 @@ class VsCodeJobService(JobServiceBase):
     :type status: str
     :param kwargs: A dictionary of additional configuration parameters.
     :type kwargs: dict
-    :ivar job_service_type: Specifies the type of job service. Set automatically to "vs_code" for this class.
+    :ivar type: Specifies the type of job service. Set automatically to "vs_code" for this class.
     :vartype type: str
     """
 
@@ -374,7 +371,7 @@ def __init__(
             properties=properties,
             **kwargs,
         )
-        self.job_service_type = JobServiceTypeNames.EntityNames.VS_CODE
+        self.type = JobServiceTypeNames.EntityNames.VS_CODE
 
     @classmethod
     def _from_rest_object(cls, obj: RestJobService) -> "VsCodeJobService":

sdk/ml/azure-ai-ml/tests/dsl/e2etests/test_dsl_pipeline.py

@@ -2571,9 +2571,9 @@ def pipeline(job_in_number, job_in_other_number, job_in_path):
         assert "Studio" in default_services
         assert "Tracking" in default_services
         assert default_services["Studio"]["endpoint"].startswith("https://ml.azure.com/runs/")
-        assert default_services["Studio"]["job_service_type"] == "Studio"
+        assert default_services["Studio"]["type"] == "Studio"
         assert default_services["Tracking"]["endpoint"].startswith("azureml://")
-        assert default_services["Tracking"]["job_service_type"] == "Tracking"
+        assert default_services["Tracking"]["type"] == "Tracking"
 
     def test_group_outputs_description_overwrite(self, client):
         # test group outputs description overwrite

sdk/ml/azure-ai-ml/tests/dsl/unittests/test_command_builder.py

@@ -841,9 +841,9 @@ def test_spark_job_with_additional_conf(self):
 
     def test_command_services_nodes(self) -> None:
         services = {
-            "my_jupyterlab": JobService(job_service_type="jupyter_lab", nodes="all"),
+            "my_jupyterlab": JobService(type="jupyter_lab", nodes="all"),
             "my_tensorboard": JobService(
-                job_service_type="tensor_board",
+                type="tensor_board",
                 properties={
                     "logDir": "~/tblog",
                 },
@@ -867,14 +867,14 @@ def test_command_services_nodes(self) -> None:
 
     def test_command_services(self) -> None:
         services = {
-            "my_ssh": JobService(job_service_type="ssh"),
+            "my_ssh": JobService(type="ssh"),
             "my_tensorboard": JobService(
-                job_service_type="tensor_board",
+                type="tensor_board",
                 properties={
                     "logDir": "~/tblog",
                 },
             ),
-            "my_jupyterlab": JobService(job_service_type="jupyter_lab"),
+            "my_jupyterlab": JobService(type="jupyter_lab"),
         }
         rest_services = {
             "my_ssh": {"job_service_type": "SSH"},

sdk/ml/azure-ai-ml/tests/dsl/unittests/test_dsl_pipeline_with_specific_nodes.py

@@ -2764,15 +2764,15 @@ def sample_pipeline_with_new_services():
 
     def test_pipeline_with_command_services_with_deprecatable_JobService(self):
         services = {
-            "my_ssh": JobService(job_service_type="ssh"),
+            "my_ssh": JobService(type="ssh"),
             "my_tensorboard": JobService(
-                job_service_type="tensor_board",
+                type="tensor_board",
                 properties={
                     "logDir": "~/tblog",
                 },
             ),
-            "my_jupyterlab": JobService(job_service_type="jupyter_lab"),
-            "my_vscode": JobService(job_service_type="vs_code"),
+            "my_jupyterlab": JobService(type="jupyter_lab"),
+            "my_vscode": JobService(type="vs_code"),
         }
         rest_services = {
             "my_ssh": {"job_service_type": "SSH"},
@@ -2827,7 +2827,7 @@ def sample_pipeline():
         assert isinstance(node_services.get("my_vscode"), VsCodeJobService)
 
         # test set services in pipeline
-        new_services = {"my_jupyter": JobService(job_service_type="jupyter_lab")}
+        new_services = {"my_jupyter": JobService(type="jupyter_lab")}
         rest_new_services = {"my_jupyter": {"job_service_type": "JupyterLab"}}
 
         @dsl.pipeline()

sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/helloworld_pipeline_job_with_node_services.yml

@@ -19,12 +19,12 @@ jobs:
       code: "./"
     services:
       "my_ssh":
-        job_service_type: "ssh"
+        type: "ssh"
         ssh_public_keys: "xyz123"
       "my_tensorboard":
-        job_service_type: "tensor_board"
+        type: "tensor_board"
         log_dir: "~/tblog" # where you want to store the tensor_board output
       "my_jupyterlab":
-        job_service_type: "jupyter_lab"
+        type: "jupyter_lab"
       "my_vscode":
-        job_service_type: "vs_code"
+        type: "vs_code"

sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/helloworld_pipeline_job_with_node_services_inline_job.yml

@@ -14,12 +14,12 @@ jobs:
     environment: azureml:AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33
     services:
       "my_ssh":
-        job_service_type: "ssh"
+        type: "ssh"
         ssh_public_keys: "xyz123"
       "my_tensorboard":
-        job_service_type: "tensor_board"
+        type: "tensor_board"
         log_dir: "~/tblog" # where you want to store the tensor_board output
       "my_jupyterlab":
-        job_service_type: "jupyter_lab"
+        type: "jupyter_lab"
       "my_vscode":
-        job_service_type: "vs_code"
+        type: "vs_code"

sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/helloworld_pipeline_job_with_node_services_inline_job_with_properties.yml

@@ -14,14 +14,14 @@ jobs:
     environment: azureml:AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33
     services:
       "my_ssh":
-        job_service_type: "ssh"
+        type: "ssh"
         properties:
           sshPublicKeys: "xyz123"
       "my_tensorboard":
-        job_service_type: "tensor_board"
+        type: "tensor_board"
         properties:
           logDir: "~/tblog" # where you want to store the tensor_board output
       "my_jupyterlab":
-        job_service_type: "jupyter_lab"
+        type: "jupyter_lab"
       "my_vscode":
-        job_service_type: "vs_code"
+        type: "vs_code"

sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/helloworld_pipeline_job_with_node_services_with_properties.yml

@@ -19,15 +19,15 @@ jobs:
       code: "./"
     services:
       "my_ssh":
-        job_service_type: "ssh"
+        type: "ssh"
         properties:
           sshPublicKeys: "xyz123"
       "my_tensorboard":
-        job_service_type: "tensor_board"
+        type: "tensor_board"
         properties:
           logDir: "~/tblog" # where you want to store the tensor_board output
       "my_jupyterlab":
-        job_service_type: "jupyter_lab"
+        type: "jupyter_lab"
       "my_vscode":
-        job_service_type: "vs_code"
+        type: "vs_code"