[ML] Add docstrings to JobService class (Azure#28599)

* [ML] Add docstrings to JobService class

Author: TonyJ1

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

@@ -3,7 +3,7 @@
 ## 1.4.0 (Unreleased)
 
 ### Features Added
--Add dedicated classes for each type of job service. The classes added are `JupyterLabJobService, SshJobService, TensorBoardJobService, VsCodeJobService` with a few properties specific to the type.
+- Added dedicated classes for each type of job service and updated the docstrings. The classes added are `JupyterLabJobService, SshJobService, TensorBoardJobService, VsCodeJobService` with a few properties specific to the type.
 
 ### Bugs Fixed
 - Fixed an issue where the ordering of `.amlignore` and `.gitignore` files are not respected

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

@@ -19,7 +19,7 @@
 
 @experimental
 class JobServiceBase(RestTranslatableMixin):
-    """JobService configuration.
+    """Base class for job service configuration.
 
     :param endpoint: Url for endpoint.
     :type endpoint: str
@@ -35,6 +35,8 @@ class JobServiceBase(RestTranslatableMixin):
     :type properties: dict[str, str]
     :param status: Status of endpoint.
     :type status: str
+    :param kwargs: A dictionary of additional configuration parameters.
+    :type kwargs: dict
     """
 
     def __init__(
@@ -148,6 +150,27 @@ def _from_rest_job_services(
 
 @experimental
 class JobService(JobServiceBase):
+    """Basic job service configuration for backward compatibility.
+        Use JupyterLabJobService, SshJobService, TensorBoardJobService or VsCodeJobService
+        specific to your job type instead of JobService.
+
+    :param endpoint: Url for endpoint.
+    :type endpoint: str
+    :param job_service_type: Endpoint type.
+        Accepts "jupyter_lab", "ssh", "tensor_board", "vs_code"
+    :type job_service_type: str
+    :param port: Port for endpoint.
+    :type nodes: str
+    :param nodes: Indicates whether the service has to run in all nodes.
+    :type port: int
+    :param properties: Additional properties to set on the endpoint.
+    :type properties: dict[str, str]
+    :param status: Status of endpoint.
+    :type status: str
+    :param kwargs: A dictionary of additional configuration parameters.
+    :type kwargs: dict
+    """
+
     @classmethod
     def _from_rest_object(cls, obj: RestJobService) -> "JobService":
         return cls._from_rest_job_service_object(obj)
@@ -158,6 +181,26 @@ def _to_rest_object(self) -> RestJobService:
 
 @experimental
 class SshJobService(JobServiceBase):
+    """SSH job service configuration.
+
+    :param endpoint: Url for endpoint.
+    :type endpoint: str
+    :param port: Port for endpoint.
+    :type nodes: str
+    :param nodes: Indicates whether the service has to run in all nodes.
+    :type port: int
+    :param properties: Additional properties to set on the endpoint.
+    :type properties: dict[str, str]
+    :param status: Status of endpoint.
+    :type status: str
+    :param ssh_public_keys: SSH Public Key to access job container via SSH.
+    :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.
+    :vartype type: str
+    """
+
     def __init__(
         self,
         *,
@@ -193,6 +236,26 @@ def _to_rest_object(self) -> RestJobService:
 
 @experimental
 class TensorBoardJobService(JobServiceBase):
+    """TensorBoard job service configuration.
+
+    :param endpoint: Url for endpoint.
+    :type endpoint: str
+    :param port: Port for endpoint.
+    :type nodes: str
+    :param nodes: Indicates whether the service has to run in all nodes.
+    :type port: int
+    :param properties: Additional properties to set on the endpoint.
+    :type properties: dict[str, str]
+    :param status: Status of endpoint.
+    :type status: str
+    :param log_dir: Log directory path.
+    :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.
+    :vartype type: str
+    """
+
     def __init__(
         self,
         *,
@@ -228,6 +291,24 @@ def _to_rest_object(self) -> RestJobService:
 
 @experimental
 class JupyterLabJobService(JobServiceBase):
+    """JupyterLab job service configuration.
+
+    :param endpoint: Url for endpoint.
+    :type endpoint: str
+    :param port: Port for endpoint.
+    :type nodes: str
+    :param nodes: Indicates whether the service has to run in all nodes.
+    :type port: int
+    :param properties: Additional properties to set on the endpoint.
+    :type properties: dict[str, str]
+    :param status: Status of endpoint.
+    :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.
+    :vartype type: str
+    """
+
     def __init__(
         self,
         *,
@@ -258,6 +339,24 @@ def _to_rest_object(self) -> RestJobService:
 
 @experimental
 class VsCodeJobService(JobServiceBase):
+    """VS Code job service configuration.
+
+    :param endpoint: Url for endpoint.
+    :type endpoint: str
+    :param port: Port for endpoint.
+    :type nodes: str
+    :param nodes: Indicates whether the service has to run in all nodes.
+    :type port: int
+    :param properties: Additional properties to set on the endpoint.
+    :type properties: dict[str, str]
+    :param status: Status of endpoint.
+    :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.
+    :vartype type: str
+    """
+
     def __init__(
         self,
         *,