Using logging instead of prints

martinRenou · martinRenou · commit e816d6709a34 · 2023-09-22T09:44:11.000+02:00
diff --git a/src/sagemaker/base_predictor.py b/src/sagemaker/base_predictor.py
@@ -14,6 +14,7 @@
 from __future__ import print_function, absolute_import
 
 import abc
+import logging
 from typing import Any, Tuple
 
 from sagemaker.deprecations import (
@@ -54,6 +55,9 @@
 from sagemaker.lineage.context import EndpointContext
 
 
+logger = logging.getLogger(__name__)
+
+
 class PredictorBase(abc.ABC):
     """An object that encapsulates a deployed model."""
 
@@ -452,7 +456,7 @@ def list_monitors(self):
             endpoint_name=self.endpoint_name
         )
         if len(monitoring_schedules_dict["MonitoringScheduleSummaries"]) == 0:
-            print("No monitors found for endpoint. endpoint: {}".format(self.endpoint_name))
+            logger.debug("No monitors found for endpoint. endpoint: %s", self.endpoint_name)
             return []
 
         monitors = []
diff --git a/src/sagemaker/cli/compatibility/v2/files.py b/src/sagemaker/cli/compatibility/v2/files.py
@@ -22,7 +22,8 @@
 
 from sagemaker.cli.compatibility.v2.ast_transformer import ASTTransformer
 
-LOGGER = logging.getLogger(__name__)
+# Setting LOGGER for backward compatibility, in case users import this...
+logger = LOGGER = logging.getLogger(__name__)
 
 
 class FileUpdater(object):
@@ -59,7 +60,7 @@ def _make_output_dirs_if_needed(self):
             os.makedirs(output_dir)
 
         if os.path.exists(self.output_path):
-            LOGGER.warning("Overwriting file %s", self.output_path)
+            logger.warning("Overwriting file %s", self.output_path)
 
 
 class PyFileUpdater(FileUpdater):
diff --git a/src/sagemaker/fw_utils.py b/src/sagemaker/fw_utils.py
@@ -473,7 +473,7 @@ def tar_and_upload_dir(
         if s3_resource is None:
             s3_resource = session.resource("s3", region_name=session.region_name)
         else:
-            print("Using provided s3_resource")
+            logger.debug("Using provided s3_resource")
 
         s3_resource.Object(bucket, key).upload_file(tar_file, ExtraArgs=extra_args)
     finally:
diff --git a/src/sagemaker/inference_recommender/inference_recommender_mixin.py b/src/sagemaker/inference_recommender/inference_recommender_mixin.py
@@ -28,7 +28,8 @@
     "mxnet": "MXNET",
 }
 
-LOGGER = logging.getLogger("sagemaker")
+# Setting LOGGER for backward compatibility, in case users import it...
+logger = LOGGER = logging.getLogger("sagemaker")
 
 
 class Phase:
@@ -145,10 +146,10 @@ def right_size(
         )
 
         if endpoint_configurations or traffic_pattern or stopping_conditions or resource_limit:
-            LOGGER.info("Advanced Job parameters were specified. Running Advanced job...")
+            logger.info("Advanced Job parameters were specified. Running Advanced job...")
             job_type = "Advanced"
         else:
-            LOGGER.info("Advanced Job parameters were not specified. Running Default job...")
+            logger.info("Advanced Job parameters were not specified. Running Default job...")
             job_type = "Default"
 
         self._init_sagemaker_session_if_does_not_exist()
@@ -173,7 +174,7 @@ def right_size(
                 vpc_config=self.vpc_config,
                 enable_network_isolation=self.enable_network_isolation(),
             )
-            LOGGER.warning("Attempting to create new model with name %s", self.name)
+            logger.warning("Attempting to create new model with name %s", self.name)
             self.sagemaker_session.create_model(**create_model_args)
 
         ret_name = self.sagemaker_session.create_inference_recommendations_job(
@@ -281,23 +282,23 @@ def _update_params_for_right_size(
         if accelerator_type:
             raise ValueError("accelerator_type is not compatible with right_size().")
         if instance_type or initial_instance_count:
-            LOGGER.warning(
+            logger.warning(
                 "instance_type or initial_instance_count specified."
                 "Overriding right_size() recommendations."
             )
             return None
         if async_inference_config:
-            LOGGER.warning(
+            logger.warning(
                 "async_inference_config is specified. Overriding right_size() recommendations."
             )
             return None
         if serverless_inference_config:
-            LOGGER.warning(
+            logger.warning(
                 "serverless_inference_config is specified. Overriding right_size() recommendations."
             )
             return None
         if explainer_config:
-            LOGGER.warning(
+            logger.warning(
                 "explainer_config is specified. Overriding right_size() recommendations."
             )
             return None
@@ -363,7 +364,7 @@ def _update_params_for_recommendation_id(
         """
 
         if instance_type is not None and initial_instance_count is not None:
-            LOGGER.warning(
+            logger.warning(
                 "Both instance_type and initial_instance_count are specified,"
                 "overriding the recommendation result."
             )
diff --git a/src/sagemaker/local/entities.py b/src/sagemaker/local/entities.py
@@ -669,8 +669,9 @@ def start(self, **kwargs):
         execution = _LocalPipelineExecution(execution_id, self.pipeline, **kwargs)
 
         self._executions[execution_id] = execution
-        print(
-            f"Starting execution for pipeline {self.pipeline.name}. Execution ID is {execution_id}"
+        logger.info(
+            "Starting execution for pipeline %s. Execution ID is %s",
+            self.pipeline.name, execution_id
         )
         self.last_modified_time = datetime.datetime.now().timestamp()
 
@@ -733,31 +734,31 @@ def update_execution_success(self):
         """Mark execution as succeeded."""
         self.status = _LocalExecutionStatus.SUCCEEDED.value
         self.last_modified_time = datetime.datetime.now().timestamp()
-        print(f"Pipeline execution {self.pipeline_execution_name} SUCCEEDED")
+        logger.info("Pipeline execution %s SUCCEEDED", self.pipeline_execution_name)
 
     def update_execution_failure(self, step_name, failure_message):
         """Mark execution as failed."""
         self.status = _LocalExecutionStatus.FAILED.value
         self.failure_reason = f"Step '{step_name}' failed with message: {failure_message}"
         self.last_modified_time = datetime.datetime.now().timestamp()
-        print(
-            f"Pipeline execution {self.pipeline_execution_name} FAILED because step "
-            f"'{step_name}' failed."
+        logger.info(
+            "Pipeline execution %s FAILED because step "
+            "'%s' failed.", self.pipeline_execution_name, step_name
         )
 
     def update_step_properties(self, step_name, step_properties):
         """Update pipeline step execution output properties."""
         self.step_execution.get(step_name).update_step_properties(step_properties)
-        print(f"Pipeline step '{step_name}' SUCCEEDED.")
+        logger.info("Pipeline step '%s' SUCCEEDED.", step_name)
 
     def update_step_failure(self, step_name, failure_message):
         """Mark step_name as failed."""
-        print(f"Pipeline step '{step_name}' FAILED. Failure message is: {failure_message}")
+        logger.info("Pipeline step '%s' FAILED. Failure message is: %s", step_name, failure_message)
         self.step_execution.get(step_name).update_step_failure(failure_message)
 
     def mark_step_executing(self, step_name):
         """Update pipelines step's status to EXECUTING and start_time to now."""
-        print(f"Starting pipeline step: '{step_name}'")
+        logger.info("Starting pipeline step: '%s'", step_name)
         self.step_execution.get(step_name).mark_step_executing()
 
     def _initialize_step_execution(self, steps):
diff --git a/src/sagemaker/local/image.py b/src/sagemaker/local/image.py
@@ -189,7 +189,7 @@ def process(
 
         # Print our Job Complete line to have a similar experience to training on SageMaker where
         # you see this line at the end.
-        print("===== Job Complete =====")
+        logger.info("===== Job Complete =====")
 
     def train(self, input_data_config, output_data_config, hyperparameters, environment, job_name):
         """Run a training job locally using docker-compose.
@@ -269,7 +269,7 @@ def train(self, input_data_config, output_data_config, hyperparameters, environm
 
         # Print our Job Complete line to have a similar experience to training on SageMaker where
         # you see this line at the end.
-        print("===== Job Complete =====")
+        logger.info("===== Job Complete =====")
         return artifacts
 
     def serve(self, model_dir, environment):
diff --git a/src/sagemaker/model.py b/src/sagemaker/model.py
@@ -72,7 +72,8 @@
     InferenceRecommenderMixin,
 )
 
-LOGGER = logging.getLogger("sagemaker")
+# Setting LOGGER for backward compatibility, in case users import it...
+logger = LOGGER = logging.getLogger("sagemaker")
 
 NEO_ALLOWED_FRAMEWORKS = set(
     ["mxnet", "tensorflow", "keras", "pytorch", "onnx", "xgboost", "tflite"]
@@ -682,7 +683,7 @@ def _upload_code(self, key_prefix: str, repack: bool = False) -> None:
                     script_name=os.path.basename(self.entry_point),
                 )
 
-            LOGGER.info(
+            logger.info(
                 "Repacking model artifact (%s), script artifact "
                 "(%s), and dependencies (%s) "
                 "into single tar.gz file located at %s. "
@@ -1167,13 +1168,13 @@ def compile(
                 self.image_uri = job_status.get("InferenceImage", None)
                 self._is_compiled_model = True
             else:
-                LOGGER.warning(
+                logger.warning(
                     "The instance type %s is not supported for deployment via SageMaker."
                     "Please deploy the model manually.",
                     target_instance_family,
                 )
         else:
-            LOGGER.warning(
+            logger.warning(
                 "Devices described by Target Platform OS, Architecture and Accelerator are not"
                 "supported for deployment via SageMaker. Please deploy the model manually."
             )
@@ -1360,7 +1361,7 @@ def deploy(
             )
 
         if instance_type and instance_type.startswith("ml.inf") and not self._is_compiled_model:
-            LOGGER.warning(
+            logger.warning(
                 "Your model is not compiled. Please compile your model before using Inferentia."
             )
 
diff --git a/src/sagemaker/model_monitor/clarify_model_monitoring.py b/src/sagemaker/model_monitor/clarify_model_monitoring.py
@@ -29,7 +29,8 @@
 from sagemaker.clarify import SageMakerClarifyProcessor, ModelPredictedLabelConfig
 from sagemaker.lineage._utils import get_resource_name_from_arn
 
-_LOGGER = logging.getLogger(__name__)
+# Setting _LOGGER for backward compatibility, in case users import it...
+logger = _LOGGER = logging.getLogger(__name__)
 
 
 class ClarifyModelMonitor(mm.ModelMonitor):
@@ -223,7 +224,7 @@ def _upload_analysis_config(self, analysis_config, output_s3_uri, job_definition
             str(uuid.uuid4()),
             "analysis_config.json",
         )
-        _LOGGER.info("Uploading analysis config to {s3_uri}.")
+        logger.info("Uploading analysis config to {s3_uri}.")
         return s3.S3Uploader.upload_string_as_file_body(
             json.dumps(analysis_config),
             desired_s3_uri=s3_uri,
@@ -598,7 +599,7 @@ def create_monitoring_schedule(
                 "Monitoring Schedule. To create another, first delete the existing one "
                 "using my_monitor.delete_monitoring_schedule()."
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         if (batch_transform_input is not None) ^ (endpoint_input is None):
@@ -607,7 +608,7 @@ def create_monitoring_schedule(
                 "Amazon Model Monitoring Schedule. "
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # create job definition
@@ -653,15 +654,15 @@ def create_monitoring_schedule(
             self.job_definition_name = new_job_definition_name
             self.monitoring_schedule_name = monitor_schedule_name
         except Exception:
-            _LOGGER.exception("Failed to create monitoring schedule.")
+            logger.exception("Failed to create monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_bias_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     # noinspection PyMethodOverriding
@@ -740,7 +741,7 @@ def update_monitoring_schedule(
                 "Amazon Model Monitoring Schedule. "
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # Only need to update schedule expression
@@ -799,15 +800,15 @@ def update_monitoring_schedule(
             if network_config is not None:
                 self.network_config = network_config
         except Exception:
-            _LOGGER.exception("Failed to update monitoring schedule.")
+            logger.exception("Failed to update monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_bias_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     def delete_monitoring_schedule(self):
@@ -817,7 +818,7 @@ def delete_monitoring_schedule(self):
         message = "Deleting Model Bias Job Definition with name: {}".format(
             self.job_definition_name
         )
-        _LOGGER.info(message)
+        logger.info(message)
         self.sagemaker_session.sagemaker_client.delete_model_bias_job_definition(
             JobDefinitionName=self.job_definition_name
         )
@@ -1018,7 +1019,7 @@ def create_monitoring_schedule(
                 "Monitoring Schedule. To create another, first delete the existing one "
                 "using my_monitor.delete_monitoring_schedule()."
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         if (batch_transform_input is not None) ^ (endpoint_input is None):
@@ -1027,7 +1028,7 @@ def create_monitoring_schedule(
                 "Amazon Model Monitoring Schedule."
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # create job definition
@@ -1074,15 +1075,15 @@ def create_monitoring_schedule(
             self.job_definition_name = new_job_definition_name
             self.monitoring_schedule_name = monitor_schedule_name
         except Exception:
-            _LOGGER.exception("Failed to create monitoring schedule.")
+            logger.exception("Failed to create monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_explainability_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     # noinspection PyMethodOverriding
@@ -1159,7 +1160,7 @@ def update_monitoring_schedule(
                 "Amazon Model Monitoring Schedule. "
                 "Please provide only one of the above required inputs"
             )
-            _LOGGER.error(message)
+            logger.error(message)
             raise ValueError(message)
 
         # Only need to update schedule expression
@@ -1221,15 +1222,15 @@ def update_monitoring_schedule(
             if network_config is not None:
                 self.network_config = network_config
         except Exception:
-            _LOGGER.exception("Failed to update monitoring schedule.")
+            logger.exception("Failed to update monitoring schedule.")
             # noinspection PyBroadException
             try:
                 self.sagemaker_session.sagemaker_client.delete_model_explainability_job_definition(
                     JobDefinitionName=new_job_definition_name
                 )
             except Exception:  # pylint: disable=W0703
                 message = "Failed to delete job definition {}.".format(new_job_definition_name)
-                _LOGGER.exception(message)
+                logger.exception(message)
             raise
 
     def delete_monitoring_schedule(self):
@@ -1239,7 +1240,7 @@ def delete_monitoring_schedule(self):
         message = "Deleting Model Explainability Job Definition with name: {}".format(
             self.job_definition_name
         )
-        _LOGGER.info(message)
+        logger.info(message)
         self.sagemaker_session.sagemaker_client.delete_model_explainability_job_definition(
             JobDefinitionName=self.job_definition_name
         )
diff --git a/src/sagemaker/model_monitor/model_monitoring.py b/src/sagemaker/model_monitor/model_monitoring.py
diff --git a/src/sagemaker/model_monitor/monitoring_files.py b/src/sagemaker/model_monitor/monitoring_files.py
diff --git a/src/sagemaker/session.py b/src/sagemaker/session.py
diff --git a/tests/integ/timeout.py b/tests/integ/timeout.py
