chore: resolve git comments, fix model id capitalization

Author: evakravi

CHANGELOG.md

@@ -66,7 +66,7 @@
 ### Features
 
  * override jumpstart content bucket
- * jumpstart model id suggestions
+ * jumpstart model ID suggestions
  * adding customer metadata support to registermodel step
 
 ### Bug Fixes and Other Changes

doc/doc_utils/jumpstart_doc_utils.py

@@ -56,9 +56,9 @@ def create_jumpstart_model_table():
     file_content.append("==================================\n")
     file_content.append(
         """
-    JumpStart for the SageMaker Python SDK uses model ids and model versions to access the necessary
+    JumpStart for the SageMaker Python SDK uses model IDs and model versions to access the necessary
     utilities. This table serves to provide the core material plus some extra information that can be useful
-    in selecting the correct model id and corresponding parameters.\n
+    in selecting the correct model ID and corresponding parameters.\n
     """
     )
     file_content.append(

doc/overview.rst

@@ -636,7 +636,7 @@ the ``model_id`` and ``model_version`` needed to retrieve the URI.
       model. To use the latest version, enter ``"*"``. This is a
       required parameter.
 
-To retrieve a model, first select a ``model id`` and ``version`` from
+To retrieve a model, first select a ``model ID`` and ``version`` from
 the :doc:`available models <./doc_utils/jumpstart>`.
 
 .. code:: python

src/sagemaker/jumpstart/accessors.py

@@ -84,8 +84,8 @@ def get_model_header(region: str, model_id: str, version: str) -> JumpStartModel
 
         Args:
             region (str): region for which to retrieve header.
-            model_id (str): model id to retrieve.
-            version (str): semantic version to retrieve for the model id.
+            model_id (str): model ID to retrieve.
+            version (str): semantic version to retrieve for the model ID.
         """
         cache_kwargs = JumpStartModelsAccessor._validate_and_mutate_region_cache_kwargs(
             JumpStartModelsAccessor._cache_kwargs, region
@@ -101,8 +101,8 @@ def get_model_specs(region: str, model_id: str, version: str) -> JumpStartModelS
 
         Args:
             region (str): region for which to retrieve header.
-            model_id (str): model id to retrieve.
-            version (str): semantic version to retrieve for the model id.
+            model_id (str): model ID to retrieve.
+            version (str): semantic version to retrieve for the model ID.
         """
         cache_kwargs = JumpStartModelsAccessor._validate_and_mutate_region_cache_kwargs(
             JumpStartModelsAccessor._cache_kwargs, region

src/sagemaker/jumpstart/cache.py

@@ -146,16 +146,16 @@ def _get_manifest_key_from_model_id_semantic_version(
         key: JumpStartVersionedModelId,
         value: Optional[JumpStartVersionedModelId],  # pylint: disable=W0613
     ) -> JumpStartVersionedModelId:
-        """Return model id and version in manifest that matches semantic version/id.
+        """Return model ID and version in manifest that matches semantic version/id.
 
         Uses ``packaging.version`` to perform version comparison. The highest model version
         matching the semantic version is used, which is compatible with the SageMaker
         version.
 
         Args:
-            key (JumpStartVersionedModelId): Key for which to fetch versioned model id.
+            key (JumpStartVersionedModelId): Key for which to fetch versioned model ID.
             value (Optional[JumpStartVersionedModelId]): Unused variable for current value of
-                old cached model id/version.
+                old cached model ID/version.
 
         Raises:
             KeyError: If the semantic version is not found in the manifest, or is found but
@@ -287,10 +287,10 @@ def get_manifest(self) -> List[JumpStartModelHeader]:
         return manifest
 
     def get_header(self, model_id: str, semantic_version_str: str) -> JumpStartModelHeader:
-        """Return header for a given JumpStart model id and semantic version.
+        """Return header for a given JumpStart model ID and semantic version.
 
         Args:
-            model_id (str): model id for which to get a header.
+            model_id (str): model ID for which to get a header.
             semantic_version_str (str): The semantic version for which to get a
                 header.
         """
@@ -331,7 +331,7 @@ def _get_header_impl(
         Allows a single retry if the cache is old.
 
         Args:
-            model_id (str): model id for which to get a header.
+            model_id (str): model ID for which to get a header.
             semantic_version_str (str): The semantic version for which to get a
                 header.
             attempt (int): attempt number at retrieving a header.
@@ -353,10 +353,10 @@ def _get_header_impl(
             return self._get_header_impl(model_id, semantic_version_str, attempt + 1)
 
     def get_specs(self, model_id: str, semantic_version_str: str) -> JumpStartModelSpecs:
-        """Return specs for a given JumpStart model id and semantic version.
+        """Return specs for a given JumpStart model ID and semantic version.
 
         Args:
-            model_id (str): model id for which to get specs.
+            model_id (str): model ID for which to get specs.
             semantic_version_str (str): The semantic version for which to get
                 specs.
         """
@@ -369,6 +369,6 @@ def get_specs(self, model_id: str, semantic_version_str: str) -> JumpStartModelS
         return specs  # type: ignore
 
     def clear(self) -> None:
-        """Clears the model id/version and s3 cache."""
+        """Clears the model ID/version and s3 cache."""
         self._s3_cache.clear()
         self._model_id_semantic_version_manifest_key_cache.clear()

src/sagemaker/jumpstart/exceptions.py

@@ -49,7 +49,7 @@ def __init__(
         """Instantiates VulnerableJumpStartModelError exception.
 
         Args:
-            model_id (Optional[str]): model id of vulnerable JumpStart model.
+            model_id (Optional[str]): model ID of vulnerable JumpStart model.
                 (Default: None).
             version (Optional[str]): version of vulnerable JumpStart model.
                 (Default: None).

src/sagemaker/jumpstart/filters.py

@@ -97,12 +97,12 @@ def eval(self) -> None:
         return
 
     @property
-    def resolved_value(self):
+    def resolved_value(self) -> BooleanValues:
         """Getter method for resolved_value."""
         return self._resolved_value
 
     @resolved_value.setter
-    def resolved_value(self, new_resolved_value: Any):
+    def resolved_value(self, new_resolved_value: Any) -> None:
         """Setter method for resolved_value. Resolved_value must be of type ``BooleanValues``."""
         if isinstance(new_resolved_value, BooleanValues):
             self._resolved_value = new_resolved_value
@@ -272,7 +272,7 @@ def eval(self) -> None:
         """Evaluates operator.
 
         Raises:
-            RuntimeError: If the operands remain unevaluated after calling ``eval``,
+            RuntimeError: If the operand remains unevaluated after calling ``eval``,
                 or if the resolved value isn't a ``BooleanValues`` type.
         """
         if not issubclass(type(self.operand), Operand):
@@ -363,7 +363,7 @@ def eval(self) -> None:
         """Evaluates operator.
 
         Raises:
-            RuntimeError: If the operands remain unevaluated after calling ``eval``,
+            RuntimeError: If the operand remains unevaluated after calling ``eval``,
                 or if the resolved value isn't a ``BooleanValues`` type.
         """
 

src/sagemaker/jumpstart/notebook_utils.py

@@ -37,8 +37,8 @@ def _compare_model_version_tuples(  # pylint: disable=too-many-return-statements
     """Performs comparison of sdk specs paths, in order to sort them.
 
     Args:
-        model_version_1 (Tuple[str, str]): The first model id and version tuple to compare.
-        model_version_2 (Tuple[str, str]): The second model id and version tuple to compare.
+        model_version_1 (Tuple[str, str]): The first model ID and version tuple to compare.
+        model_version_2 (Tuple[str, str]): The second model ID and version tuple to compare.
     """
     if model_version_1 is None or model_version_2 is None:
         if model_version_2 is not None:
@@ -112,7 +112,7 @@ def extract_framework_task_model(model_id: str) -> Tuple[str, str, str]:
         model_id (str): The model ID for which to extract the framework/task/model.
 
     Raises:
-        ValueError: If the model id cannot be parsed into at least 3 components seperated by
+        ValueError: If the model ID cannot be parsed into at least 3 components seperated by
             "-" character.
     """
     _id_parts = model_id.split("-")
@@ -356,7 +356,7 @@ def _generate_jumpstart_model_versions(  # pylint: disable=redefined-builtin
         if copied_filter.resolved_value == BooleanValues.UNEVALUATED:
             raise RuntimeError(
                 "Filter expression in unevaluated state after using values from model manifest. "
-                "Model id and version that is failing: "
+                "Model ID and version that is failing: "
                 f"{(model_manifest.model_id, model_manifest.version)}."
             )
         copied_filter_2 = copy.deepcopy(filter)
@@ -395,7 +395,7 @@ def _generate_jumpstart_model_versions(  # pylint: disable=redefined-builtin
 
         raise RuntimeError(
             "Filter expression in unevaluated state after using values from model specs. "
-            "Model id and version that is failing: "
+            "Model ID and version that is failing: "
             f"{(model_manifest.model_id, model_manifest.version)}."
         )
 

src/sagemaker/jumpstart/types.py

@@ -360,7 +360,7 @@ def to_json(self) -> Dict[str, Any]:
 
 
 class JumpStartVersionedModelId(JumpStartDataHolderType):
-    """Data class for versioned model ids."""
+    """Data class for versioned model IDs."""
 
     __slots__ = ["model_id", "version"]
 
@@ -372,7 +372,7 @@ def __init__(
         """Instantiates JumpStartVersionedModelId object.
 
         Args:
-            model_id (str): JumpStart model id.
+            model_id (str): JumpStart model ID.
             version (str): JumpStart model version.
         """
         self.model_id = model_id
@@ -418,7 +418,7 @@ def __init__(
             formatted_content (Union[Dict[JumpStartVersionedModelId, JumpStartModelHeader],
             JumpStartModelSpecs]):
                 Formatted content for model specs and mappings from
-                versioned model ids to specs.
+                versioned model IDs to specs.
             md5_hash (str): md5_hash for stored file content from s3.
         """
         self.formatted_content = formatted_content

src/sagemaker/jumpstart/utils.py

@@ -327,7 +327,7 @@ def verify_model_region_and_return_specs(
     """Verifies that an acceptable model_id, version, scope, and region combination is provided.
 
     Args:
-        model_id (Optional[str]): model id of the JumpStart model to verify and
+        model_id (Optional[str]): model ID of the JumpStart model to verify and
             obtains specs.
         version (Optional[str]): version of the JumpStart model to verify and
             obtains specs.

tests/unit/sagemaker/jumpstart/test_types.py

@@ -149,7 +149,7 @@ def test_jumpstart_model_specs():
 
     assert specs1.to_json() == BASE_SPEC
 
-    BASE_SPEC["model_id"] = "diff model id"
+    BASE_SPEC["model_id"] = "diff model ID"
     specs2 = JumpStartModelSpecs(BASE_SPEC)
     assert specs1 != specs2
 

tests/unit/sagemaker/jumpstart/utils.py

@@ -55,7 +55,7 @@ def get_header_from_base_header(
             "sklearn" not in model_id,
         ]
     ):
-        raise KeyError("Bad model id")
+        raise KeyError("Bad model ID")
 
     if region is not None and region not in JUMPSTART_REGION_NAME_SET:
         raise ValueError(
@@ -85,7 +85,7 @@ def get_prototype_model_spec(
     region: str = None, model_id: str = None, version: str = None
 ) -> JumpStartModelSpecs:
     """This function mocks cache accessor functions. For this mock,
-    we only retrieve model specs based on the model id.
+    we only retrieve model specs based on the model ID.
     """
 
     specs = JumpStartModelSpecs(PROTOTYPICAL_MODEL_SPECS_DICT[model_id])
@@ -115,7 +115,7 @@ def get_spec_from_base_spec(
             "sklearn" not in model_id,
         ]
     ):
-        raise KeyError("Bad model id")
+        raise KeyError("Bad model ID")
 
     if region is not None and region not in JUMPSTART_REGION_NAME_SET:
         raise ValueError(