Skip to content

fix: Make type annotation of UploadedCode consistent #3839

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
May 18, 2023
Merged

fix: Make type annotation of UploadedCode consistent #3839

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
6 changes: 3 additions & 3 deletions src/sagemaker/estimator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ def __init__(
self.code_location = code_location
self.entry_point = entry_point
self.dependencies = dependencies or []
self.uploaded_code = None
self.uploaded_code: Optional[UploadedCode] = None
self.tags = add_jumpstart_tags(
tags=tags, training_model_uri=self.model_uri, training_script_uri=self.source_dir
)
Expand Down Expand Up @@ -839,7 +839,7 @@ def _script_mode_hyperparam_update(self, code_dir: str, script: str) -> None:

self._hyperparameters.update(EstimatorBase._json_encode_hyperparameters(hyperparams))

def _stage_user_code_in_s3(self) -> str:
def _stage_user_code_in_s3(self) -> UploadedCode:
"""Uploads the user training script to S3 and returns the S3 URI.

Returns: S3 URI
Expand Down Expand Up @@ -3135,7 +3135,7 @@ def __init__(
self.git_config = git_config
self.source_dir = source_dir
self.dependencies = dependencies or []
self.uploaded_code = None
self.uploaded_code: Optional[UploadedCode] = None

self.container_log_level = container_log_level
self.code_location = code_location
Expand Down
8 changes: 4 additions & 4 deletions src/sagemaker/fw_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@

_TAR_SOURCE_FILENAME = "source.tar.gz"

UploadedCode = namedtuple("UserCode", ["s3_prefix", "script_name"])
"""sagemaker.fw_utils.UserCode: An object containing the S3 prefix and script name.
UploadedCode = namedtuple("UploadedCode", ["s3_prefix", "script_name"])
"""sagemaker.fw_utils.UploadedCode: An object containing the S3 prefix and script name.
This is for the source code used for the entry point with an ``Estimator``. It can be
instantiated with positional or keyword arguments.
"""
Expand Down Expand Up @@ -398,7 +398,7 @@ def tar_and_upload_dir(
kms_key=None,
s3_resource=None,
settings: Optional[SessionSettings] = None,
):
) -> UploadedCode:
"""Package source files and upload a compress tar file to S3.

The S3 location will be ``s3://<bucket>/s3_key_prefix/sourcedir.tar.gz``.
Expand Down Expand Up @@ -429,7 +429,7 @@ def tar_and_upload_dir(
of the SageMaker ``Session``, can be used to override the default encryption
behavior (default: None).
Returns:
sagemaker.fw_utils.UserCode: An object with the S3 bucket and key (S3 prefix) and
sagemaker.fw_utils.UploadedCode: An object with the S3 bucket and key (S3 prefix) and
script name.
"""
if directory and (is_pipeline_variable(directory) or directory.lower().startswith("s3://")):
Expand Down