Skip to content

Remove kwargs from docstrings #42729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2025
Merged

Remove kwargs from docstrings #42729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_assets/asset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ class Asset(Resource):
:type tags: Optional[dict[str, str]]
:param properties: The asset property dictionary. Defaults to None.
:type properties: Optional[dict[str, str]]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: Optional[dict]
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_compute/synapsespark_compute.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,6 @@ class SynapseSparkCompute(Compute):
:paramtype scale_settings: Optional[~azure.ai.ml.entities.AutoScaleSettings]
:keyword auto_pause_settings: The auto pause settings for the compute.
:paramtype auto_pause_settings: Optional[~azure.ai.ml.entities.AutoPauseSettings]
:keyword kwargs: Additional keyword arguments passed to the parent class.
:paramtype kwargs: Optional[dict]

.. admonition:: Example:

Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_credentials.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,8 +309,6 @@ class ServicePrincipalConfiguration(BaseTenantCredentials):

:param client_secret: The client secret.
:type client_secret: str
:keyword kwargs: Additional arguments to pass to the parent class.
:paramtype kwargs: Optional[dict]
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/automl/image/automl_image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ class AutoMLImage(AutoMLVertical, ABC):
:paramtype limits: Optional[~azure.ai.ml.automl.ImageLimitSettings]
:keyword sweep: Sweep settings for all AutoML Image jobs. Defaults to None.
:paramtype sweep: Optional[~azure.ai.ml.automl.ImageSweepSettings]
:keyword kwargs: Additional keyword arguments for AutoMLImage.
:paramtype kwargs: Dict[str, Any]
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions ...ml/azure-ai-ml/azure/ai/ml/entities/_job/automl/image/automl_image_classification_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ class AutoMLImageClassificationBase(AutoMLImage):
:paramtype training_parameters: Optional[~azure.ai.ml.automl.ImageModelSettingsClassification]
:keyword search_space: Search space for Automl image classification jobs. Defaults to None.
:paramtype search_space: Optional[List[~azure.ai.ml.automl.ImageClassificationSearchSpace]]
:keyword kwargs: Other Keyword arguments for AutoMLImageClassificationBase class.
:paramtype kwargs: Dict[str, Any]
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/automl/image/image_instance_segmentation_job.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ class ImageInstanceSegmentationJob(AutoMLImageObjectDetectionBase):

:keyword primary_metric: The primary metric to use for optimization.
:paramtype primary_metric: Optional[str, ~azure.ai.ml.automl.InstanceSegmentationPrimaryMetrics]
:keyword kwargs: Job-specific arguments.
:paramtype kwargs: Dict[str, Any]

.. admonition:: Example:

Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/command_job.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@ class CommandJob(Job, ParameterizedCommand, JobIOMixin):
:paramtype limits: Optional[~azure.ai.ml.entities.CommandJobLimits]
:keyword parent_job_name: parent job id for command job
:paramtype parent_job_name: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict


.. admonition:: Example:
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/data_transfer/data_transfer_job.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,6 @@ class DataTransferJob(Job, JobIOMixin):
:type task: str
:param data_copy_mode: data copy mode in copy task, possible value is "merge_with_overwrite", "fail_if_conflict".
:type data_copy_mode: str
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/job_resource_configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,6 @@ class JobResourceConfiguration(RestTranslatableMixin, DictMixin):
:paramtype shm_size: Optional[str]
:keyword max_instance_count: The maximum number of instances or nodes used by the compute target.
:paramtype max_instance_count: Optional[int]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict

.. admonition:: Example:

Expand Down
12 changes: 0 additions & 12 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/job_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ class JobServiceBase(RestTranslatableMixin, DictMixin):
:paramtype properties: Optional[dict[str, str]]
:keyword status: The status of the endpoint.
:paramtype status: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict
"""

def __init__( # pylint: disable=unused-argument
Expand Down Expand Up @@ -159,8 +157,6 @@ class JobService(JobServiceBase):
:paramtype properties: Optional[dict[str, str]]
:keyword status: The status of the endpoint.
:paramtype status: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict
"""

@classmethod
Expand Down Expand Up @@ -188,8 +184,6 @@ class SshJobService(JobServiceBase):
:paramtype status: Optional[str]
:keyword ssh_public_keys: The SSH Public Key to access the job container.
:paramtype ssh_public_keys: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict

.. admonition:: Example:

Expand Down Expand Up @@ -251,8 +245,6 @@ class TensorBoardJobService(JobServiceBase):
:paramtype status: Optional[str]
:keyword log_dir: The directory path for the log file.
:paramtype log_dir: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict

.. admonition:: Example:

Expand Down Expand Up @@ -312,8 +304,6 @@ class JupyterLabJobService(JobServiceBase):
:paramtype properties: Optional[dict[str, str]]
:keyword status: The status of the endpoint.
:paramtype status: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict

.. admonition:: Example:

Expand Down Expand Up @@ -368,8 +358,6 @@ class VsCodeJobService(JobServiceBase):
:paramtype properties: Optional[dict[str, str]]
:keyword status: The status of the endpoint.
:paramtype status: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict

.. admonition:: Example:

Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/parameterized_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,6 @@ class ParameterizedCommand:
:type environment: Optional[Union[str, ~azure.ai.ml.entities.Environment]]
:param queue_settings: The queue settings for the job.
:type queue_settings: Optional[~azure.ai.ml.entities.QueueSettings]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/parameterized_spark.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ class ParameterizedSpark(SparkJobEntryMixin):
:type environment: Optional[Union[str, ~azure.ai.ml.entities.Environment]]
:param args: The arguments for the job.
:type args: Optional[str]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/queue_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ class QueueSettings(RestTranslatableMixin, DictMixin):
:keyword priority: The priority of the job on a compute. Accepted values are "low", "medium", and "high".
Defaults to "medium".
:paramtype priority: Optional[Literal]
:keyword kwargs: Additional properties for QueueSettings.
:paramtype kwargs: Optional[dict]
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/sweep/sweep_job.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,6 @@ class SweepJob(Job, ParameterizedSweep, JobIOMixin):
:paramtype queue_settings: ~azure.ai.ml.entities.QueueSettings
:keyword resources: Compute Resource configuration for the job.
:paramtype resources: Optional[Union[~azure.ai.ml.entities.ResourceConfiguration]
:keyword kwargs: A dictionary of additional configuration parameters.
:paramtype kwargs: dict


.. admonition:: Example:
Expand Down
2 changes: 0 additions & 2 deletions sdk/ml/azure-ai-ml/azure/ai/ml/entities/_schedule/schedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ class Schedule(YamlTranslatableMixin, PathAwareSchemaValidatableMixin, Resource)
:paramtype tags: Optional[dict]]
:keyword properties: A dictionary of properties to associate with the schedule.
:paramtype properties: Optional[dict[str, str]]
:keyword kwargs: Additional keyword arguments passed to the Resource constructor.
:paramtype kwargs: dict
"""

def __init__(
Expand Down