change: fix docstrings, improve readability

Author: evakravi

src/sagemaker/estimator.py

@@ -16,7 +16,7 @@
 import json
 import logging
 import os
-from typing import Dict
+from typing import Any, Dict
 import uuid
 from abc import ABCMeta, abstractmethod
 
@@ -364,7 +364,7 @@ def __init__(
                 try to use either CodeCommit credential helper or local
                 credential storage for authentication.
             hyperparameters (dict): Dictionary containing the hyperparameters to
-                initialize this estimator with.
+                initialize this estimator with. (Default: None).
             container_log_level (int): Log level to use within the container
                 (default: logging.INFO). Valid values are defined in the Python
                 logging module.
@@ -375,7 +375,7 @@ def __init__(
                 If not specified, the default ``code location`` is s3://output_bucket/job-name/.
             entry_point (str): Path (absolute or relative) to the local Python
                 source file which should be executed as the entry point to
-                training. If ``source_dir`` is specified, then ``entry_point``
+                training. (Default: None). If ``source_dir`` is specified, then ``entry_point``
                 must point to a file located at the root of ``source_dir``.
                 If 'git_config' is provided, 'entry_point' should be
                 a relative location to the Python source file in the Git repo.
@@ -583,7 +583,7 @@ def _get_or_create_name(self, name=None):
         return name_from_base(self.base_job_name)
 
     @staticmethod
-    def _json_encode_hyperparameters(hyperparameters: dict) -> dict:
+    def _json_encode_hyperparameters(hyperparameters: Dict[str, Any]) -> Dict[str, Any]:
         """Applies Json encoding for certain Hyperparameter types, returns hyperparameters.
 
         Args:
@@ -679,7 +679,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:
-        """Upload the user training script to s3 and return the location.
+        """Upload the user training script to s3 and return the s3 URI.
 
         Returns: s3 uri
         """
@@ -2691,7 +2691,7 @@ def _model_entry_point(self):
         return None
 
     def set_hyperparameters(self, **kwargs):
-        """Sets hyperparameters."""
+        """Escape the dict argument as JSON, update the private hyperparameter attribute."""
         self._hyperparameters.update(EstimatorBase._json_encode_hyperparameters(kwargs))
 
     def hyperparameters(self):

src/sagemaker/model.py

@@ -399,12 +399,10 @@ def prepare_container_def(
         )
         deploy_env = copy.deepcopy(self.env)
         if self.source_dir or self.dependencies or self.entry_point or self.git_config:
-            self._upload_code(
-                deploy_key_prefix,
-                repack=self.source_dir
-                and self.entry_point
-                and not (self.key_prefix or self.git_config),
+            is_repack = (
+                self.source_dir and self.entry_point and not (self.key_prefix or self.git_config)
             )
+            self._upload_code(deploy_key_prefix, repack=is_repack)
             deploy_env.update(self._script_mode_env_vars())
         return sagemaker.container_def(
             self.image_uri, self.model_data, deploy_env, image_config=self.image_config