change: rename fetch_sagemaker_config to load_sagemaker_config

Author: Ruban Hussain

src/sagemaker/config/__init__.py

@@ -13,7 +13,7 @@
 """This module configures the default values for SageMaker Python SDK."""
 
 from __future__ import absolute_import
-from sagemaker.config.config import fetch_sagemaker_config, validate_sagemaker_config  # noqa: F401
+from sagemaker.config.config import load_sagemaker_config, validate_sagemaker_config  # noqa: F401
 from sagemaker.config.config_schema import (  # noqa: F401
     KEY,
     TRAINING_JOB,

src/sagemaker/config/config.py

@@ -51,7 +51,7 @@
 S3_PREFIX = "s3://"
 
 
-def fetch_sagemaker_config(
+def load_sagemaker_config(
     additional_config_paths: List[str] = None, s3_resource=_DEFAULT_S3_RESOURCE
 ) -> dict:
     """Helper method that loads config files and merges them.

src/sagemaker/local/local_session.py

@@ -21,7 +21,7 @@
 import boto3
 from botocore.exceptions import ClientError
 
-from sagemaker.config import fetch_sagemaker_config, validate_sagemaker_config
+from sagemaker.config import load_sagemaker_config, validate_sagemaker_config
 from sagemaker.local.image import _SageMakerContainer
 from sagemaker.local.utils import get_docker_host
 from sagemaker.local.entities import (
@@ -626,7 +626,7 @@ def __init__(
                 SAGEMAKER_ADMIN_CONFIG_OVERRIDE and SAGEMAKER_USER_CONFIG_OVERRIDE),
                 a new dictionary will be generated from those configuration files. Alternatively,
                 this dictionary can be generated by calling
-                :func:`~sagemaker.config.fetch_sagemaker_config` and then be provided to the
+                :func:`~sagemaker.config.load_sagemaker_config` and then be provided to the
                 Session.
         """
         self.s3_endpoint_url = s3_endpoint_url
@@ -684,11 +684,11 @@ def _initialize(
             self.sagemaker_config = (
                 sagemaker_config
                 if sagemaker_config
-                else fetch_sagemaker_config(s3_resource=self.s3_resource)
+                else load_sagemaker_config(s3_resource=self.s3_resource)
             )
         else:
             self.sagemaker_config = (
-                sagemaker_config if sagemaker_config else fetch_sagemaker_config()
+                sagemaker_config if sagemaker_config else load_sagemaker_config()
             )
 
         sagemaker_config_file = os.path.join(os.path.expanduser("~"), ".sagemaker", "config.yaml")

src/sagemaker/session.py

@@ -33,7 +33,7 @@
 import sagemaker.logs
 from sagemaker import vpc_utils
 from sagemaker._studio import _append_project_tags
-from sagemaker.config import fetch_sagemaker_config, validate_sagemaker_config  # noqa: F401
+from sagemaker.config import load_sagemaker_config, validate_sagemaker_config  # noqa: F401
 from sagemaker.config import (
     KEY,
     TRAINING_JOB,
@@ -197,7 +197,7 @@ def __init__(
                 SAGEMAKER_ADMIN_CONFIG_OVERRIDE and SAGEMAKER_USER_CONFIG_OVERRIDE),
                 a new dictionary will be generated from those configuration files. Alternatively,
                 this dictionary can be generated by calling
-                :func:`~sagemaker.config.fetch_sagemaker_config` and then be provided to the
+                :func:`~sagemaker.config.load_sagemaker_config` and then be provided to the
                 Session.
         """
         self._default_bucket = None
@@ -274,7 +274,7 @@ def _initialize(
                 s3 = self.boto_session.resource("s3", region_name=self.boto_region_name)
             else:
                 s3 = self.s3_resource
-            self.sagemaker_config = fetch_sagemaker_config(s3_resource=s3)
+            self.sagemaker_config = load_sagemaker_config(s3_resource=s3)
 
     @property
     def boto_region_name(self):

src/sagemaker/workflow/pipeline_context.py

@@ -140,7 +140,7 @@ def __init__(
                 SAGEMAKER_ADMIN_CONFIG_OVERRIDE and SAGEMAKER_USER_CONFIG_OVERRIDE),
                 a new dictionary will be generated from those configuration files. Alternatively,
                 this dictionary can be generated by calling
-                :func:`~sagemaker.config.fetch_sagemaker_config` and then be provided to the
+                :func:`~sagemaker.config.load_sagemaker_config` and then be provided to the
                 Session.
         """
         super().__init__(

tests/integ/test_sagemaker_config.py

@@ -27,7 +27,7 @@
     Predictor,
     Session,
 )
-from sagemaker.config import fetch_sagemaker_config
+from sagemaker.config import load_sagemaker_config
 from sagemaker.model_monitor import DataCaptureConfig
 from sagemaker.s3 import S3Uploader
 from sagemaker.sparkml import SparkMLModel
@@ -144,7 +144,7 @@ def sagemaker_session_with_dynamically_generated_sagemaker_config(
         sagemaker_client=sagemaker_client,
         sagemaker_runtime_client=runtime_client,
         sagemaker_metrics_client=metrics_client,
-        sagemaker_config=fetch_sagemaker_config([dynamic_sagemaker_config_yaml_path]),
+        sagemaker_config=load_sagemaker_config([dynamic_sagemaker_config_yaml_path]),
     )
 
     return session
@@ -173,7 +173,7 @@ def test_config_download_from_s3_and_merge(
     )
 
     # The thing being tested.
-    sagemaker_config = fetch_sagemaker_config(
+    sagemaker_config = load_sagemaker_config(
         additional_config_paths=[s3_uri_config_1, config_file_2_local_path]
     )
 

tests/unit/sagemaker/config/test_config.py

@@ -17,7 +17,7 @@
 import yaml
 from mock import Mock, MagicMock
 
-from sagemaker.config.config import fetch_sagemaker_config
+from sagemaker.config.config import load_sagemaker_config
 from jsonschema import exceptions
 from yaml.constructor import ConstructorError
 
@@ -37,14 +37,14 @@ def expected_merged_config(get_data_dir):
 
 
 def test_config_when_default_config_file_and_user_config_file_is_not_found():
-    assert fetch_sagemaker_config() == {}
+    assert load_sagemaker_config() == {}
 
 
 def test_config_when_overriden_default_config_file_is_not_found(get_data_dir):
     fake_config_file_path = os.path.join(get_data_dir, "config-not-found.yaml")
     os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"] = fake_config_file_path
     with pytest.raises(ValueError):
-        fetch_sagemaker_config()
+        load_sagemaker_config()
     del os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"]
 
 
@@ -55,14 +55,14 @@ def test_invalid_config_file_which_has_python_code(get_data_dir):
     # PyYAML will throw exceptions for yaml.safe_load. SageMaker Config is using
     # yaml.safe_load internally
     with pytest.raises(ConstructorError) as exception_info:
-        fetch_sagemaker_config(additional_config_paths=[invalid_config_file_path])
+        load_sagemaker_config(additional_config_paths=[invalid_config_file_path])
     assert "python/object/apply:eval" in str(exception_info.value)
 
 
 def test_config_when_additional_config_file_path_is_not_found(get_data_dir):
     fake_config_file_path = os.path.join(get_data_dir, "config-not-found.yaml")
     with pytest.raises(ValueError):
-        fetch_sagemaker_config(additional_config_paths=[fake_config_file_path])
+        load_sagemaker_config(additional_config_paths=[fake_config_file_path])
 
 
 def test_config_factory_when_override_user_config_file_is_not_found(get_data_dir):
@@ -71,15 +71,15 @@ def test_config_factory_when_override_user_config_file_is_not_found(get_data_dir
     )
     os.environ["SAGEMAKER_USER_CONFIG_OVERRIDE"] = fake_additional_override_config_file_path
     with pytest.raises(ValueError):
-        fetch_sagemaker_config()
+        load_sagemaker_config()
     del os.environ["SAGEMAKER_USER_CONFIG_OVERRIDE"]
 
 
 def test_default_config_file_with_invalid_schema(get_data_dir):
     config_file_path = os.path.join(get_data_dir, "invalid_config_file.yaml")
     os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"] = config_file_path
     with pytest.raises(exceptions.ValidationError):
-        fetch_sagemaker_config()
+        load_sagemaker_config()
     del os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"]
 
 
@@ -90,7 +90,7 @@ def test_default_config_file_when_directory_is_provided_as_the_path(
     expected_config = base_config_with_schema
     expected_config["SageMaker"] = valid_config_with_all_the_scopes
     os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"] = get_data_dir
-    assert expected_config == fetch_sagemaker_config()
+    assert expected_config == load_sagemaker_config()
     del os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"]
 
 
@@ -100,7 +100,7 @@ def test_additional_config_paths_when_directory_is_provided(
     # This will try to load config.yaml file from that directory if present.
     expected_config = base_config_with_schema
     expected_config["SageMaker"] = valid_config_with_all_the_scopes
-    assert expected_config == fetch_sagemaker_config(additional_config_paths=[get_data_dir])
+    assert expected_config == load_sagemaker_config(additional_config_paths=[get_data_dir])
 
 
 def test_default_config_file_when_path_is_provided_as_environment_variable(
@@ -110,7 +110,7 @@ def test_default_config_file_when_path_is_provided_as_environment_variable(
     # This will try to load config.yaml file from that directory if present.
     expected_config = base_config_with_schema
     expected_config["SageMaker"] = valid_config_with_all_the_scopes
-    assert expected_config == fetch_sagemaker_config()
+    assert expected_config == load_sagemaker_config()
     del os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"]
 
 
@@ -123,7 +123,7 @@ def test_merge_behavior_when_additional_config_file_path_is_not_found(
     )
     os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"] = valid_config_file_path
     with pytest.raises(ValueError):
-        fetch_sagemaker_config(additional_config_paths=[fake_additional_override_config_file_path])
+        load_sagemaker_config(additional_config_paths=[fake_additional_override_config_file_path])
     del os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"]
 
 
@@ -133,11 +133,11 @@ def test_merge_behavior(get_data_dir, expected_merged_config):
         get_data_dir, "sample_additional_config_for_merge.yaml"
     )
     os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"] = valid_config_file_path
-    assert expected_merged_config == fetch_sagemaker_config(
+    assert expected_merged_config == load_sagemaker_config(
         additional_config_paths=[additional_override_config_file_path]
     )
     os.environ["SAGEMAKER_USER_CONFIG_OVERRIDE"] = additional_override_config_file_path
-    assert expected_merged_config == fetch_sagemaker_config()
+    assert expected_merged_config == load_sagemaker_config()
     del os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"]
     del os.environ["SAGEMAKER_USER_CONFIG_OVERRIDE"]
 
@@ -160,7 +160,7 @@ def test_s3_config_file(
     config_file_s3_uri = "s3://{}/{}".format(config_file_bucket, config_file_s3_prefix)
     expected_config = base_config_with_schema
     expected_config["SageMaker"] = valid_config_with_all_the_scopes
-    assert expected_config == fetch_sagemaker_config(
+    assert expected_config == load_sagemaker_config(
         additional_config_paths=[config_file_s3_uri], s3_resource=s3_resource_mock
     )
 
@@ -174,7 +174,7 @@ def test_config_factory_when_default_s3_config_file_is_not_found(s3_resource_moc
     ).all.return_value = []
     config_file_s3_uri = "s3://{}/{}".format(config_file_bucket, config_file_s3_prefix)
     with pytest.raises(ValueError):
-        fetch_sagemaker_config(
+        load_sagemaker_config(
             additional_config_paths=[config_file_s3_uri], s3_resource=s3_resource_mock
         )
 
@@ -204,7 +204,7 @@ def test_s3_config_file_when_uri_provided_corresponds_to_a_path(
     config_file_s3_uri = "s3://{}/{}".format(config_file_bucket, config_file_s3_prefix)
     expected_config = base_config_with_schema
     expected_config["SageMaker"] = valid_config_with_all_the_scopes
-    assert expected_config == fetch_sagemaker_config(
+    assert expected_config == load_sagemaker_config(
         additional_config_paths=[config_file_s3_uri], s3_resource=s3_resource_mock
     )
 
@@ -231,7 +231,7 @@ def test_merge_of_s3_default_config_file_and_regular_config_file(
         get_data_dir, "sample_additional_config_for_merge.yaml"
     )
     os.environ["SAGEMAKER_ADMIN_CONFIG_OVERRIDE"] = config_file_s3_uri
-    assert expected_merged_config == fetch_sagemaker_config(
+    assert expected_merged_config == load_sagemaker_config(
         additional_config_paths=[additional_override_config_file_path],
         s3_resource=s3_resource_mock,
     )