Skip to content

fix: missing jumpstart estimator args #3978

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.

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 3 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions src/sagemaker/jumpstart/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ def __init__(
instance_groups: Optional[List[InstanceGroup]] = None,
training_repository_access_mode: Optional[Union[str, PipelineVariable]] = None,
training_repository_credentials_provider_arn: Optional[Union[str, PipelineVariable]] = None,
container_entry_point: Optional[List[str]] = None,
container_arguments: Optional[List[str]] = None,
disable_output_compression: Optional[bool] = None,
):
"""Initializes a ``JumpStartEstimator``.

Expand Down Expand Up @@ -484,6 +487,13 @@ def __init__(
private Docker registry where your training image is hosted (Default: None).
When it's set to None, SageMaker will not do authentication before pulling the image
in the private Docker registry. (Default: None).
container_entry_point (Optional[List[str]]): The entrypoint script for a Docker
container used to run a training job. This script takes precedence over
the default train processing instructions.
container_arguments (Optional[List[str]]): The arguments for a container used to run
a training job.
disable_output_compression (Optional[bool]): When set to true, Model is uploaded
to Amazon S3 without compression after training finishes.

Raises:
ValueError: If the model ID is not recognized by JumpStart.
Expand Down Expand Up @@ -553,6 +563,9 @@ def _is_valid_model_id_hook():
training_repository_credentials_provider_arn
),
image_uri=image_uri,
container_entry_point=container_entry_point,
container_arguments=container_arguments,
disable_output_compression=disable_output_compression,
)

self.model_id = estimator_init_kwargs.model_id
Expand Down
6 changes: 6 additions & 0 deletions src/sagemaker/jumpstart/factory/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ def get_init_kwargs(
instance_groups: Optional[List[InstanceGroup]] = None,
training_repository_access_mode: Optional[Union[str, PipelineVariable]] = None,
training_repository_credentials_provider_arn: Optional[Union[str, PipelineVariable]] = None,
container_entry_point: Optional[List[str]] = None,
container_arguments: Optional[List[str]] = None,
disable_output_compression: Optional[bool] = None,
) -> JumpStartEstimatorInitKwargs:
"""Returns kwargs required to instantiate `sagemaker.estimator.Estimator` object."""

Expand Down Expand Up @@ -168,6 +171,9 @@ def get_init_kwargs(
training_repository_access_mode=training_repository_access_mode,
training_repository_credentials_provider_arn=training_repository_credentials_provider_arn,
image_uri=image_uri,
container_entry_point=container_entry_point,
container_arguments=container_arguments,
disable_output_compression=disable_output_compression,
)

estimator_init_kwargs = _add_model_version_to_kwargs(estimator_init_kwargs)
Expand Down
9 changes: 9 additions & 0 deletions src/sagemaker/jumpstart/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,9 @@ class JumpStartEstimatorInitKwargs(JumpStartKwargs):
"training_repository_credentials_provider_arn",
"tolerate_deprecated_model",
"tolerate_vulnerable_model",
"container_entry_point",
"container_arguments",
"disable_output_compression",
]

SERIALIZATION_EXCLUSION_SET = {
Expand Down Expand Up @@ -837,6 +840,9 @@ def __init__(
training_repository_credentials_provider_arn: Optional[Union[str, Any]] = None,
tolerate_vulnerable_model: Optional[bool] = None,
tolerate_deprecated_model: Optional[bool] = None,
container_entry_point: Optional[List[str]] = None,
container_arguments: Optional[List[str]] = None,
disable_output_compression: Optional[bool] = None,
) -> None:
"""Instantiates JumpStartEstimatorInitKwargs object."""

Expand Down Expand Up @@ -890,6 +896,9 @@ def __init__(
)
self.tolerate_vulnerable_model = tolerate_vulnerable_model
self.tolerate_deprecated_model = tolerate_deprecated_model
self.container_entry_point = container_entry_point
self.container_arguments = container_arguments
self.disable_output_compression = disable_output_compression


class JumpStartEstimatorFitKwargs(JumpStartKwargs):
Expand Down
6 changes: 2 additions & 4 deletions tests/unit/sagemaker/jumpstart/estimator/test_estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -520,11 +520,9 @@ def test_jumpstart_estimator_kwargs_match_parent_class(self):

"""If you add arguments to <Estimator constructor>, this test will fail.
Please add the new argument to the skip set below,
and cut a ticket sev-3 to JumpStart team: AWS > SageMaker > JumpStart"""
and reach out to JumpStart team."""

init_args_to_skip: Set[str] = set(
["container_entry_point", "container_arguments", "disable_output_compression", "kwargs"]
)
init_args_to_skip: Set[str] = set(["kwargs"])
fit_args_to_skip: Set[str] = set()
deploy_args_to_skip: Set[str] = set(["kwargs"])

Expand Down