Create get_clearml_task for Ignite.contrib.handlers.ClearMLLogger

ignite/contrib/handlers/clearml_logger.py

@@ -178,6 +178,24 @@ def bypass_mode(cls) -> bool:
         """
         return getattr(cls, "_bypass", bool(os.environ.get("CI")))
 
+    def __getattr__(self, attr: Any) -> Any:
+        """
+        Calls the corresponding method of ``ClearML.Logger``.
+
+        Args:
+            attr: methods of the ClearML.Logger class.
+        """
+        return getattr(self.clearml_logger, attr)
+
+    def get_task(self) -> Callable:
+        """
+        Returns the task context that the logger is reporting.
+
+        Return:
+            Returns the desired task object only if bypass mode is set to ``False``.
+        """
+        return self._task
+
     def close(self) -> None:
         self.clearml_logger.flush()
 

tests/ignite/contrib/handlers/test_clearml_logger.py

@@ -977,6 +977,33 @@ def update_fn(engine, batch):
         assert lr_scheduler_value == loaded_lr_scheduler_value
 
 
+def test_clearml_logger_getattr_method(dirname):
+
+    ClearMLLogger.set_bypass_mode(True)
+    with ClearMLLogger(output_uri=dirname) as clearml_logger:
+        # Create a mock clearml.Logger() object
+        mock_logger = MagicMock()
+        clearml_logger.clearml_logger = mock_logger
+
+        # Test a method called by __getattr__ calls the corresponding method of the mock project.
+        clearml_logger.report_single_value("accuracy", 0.72)
+        mock_logger.report_single_value.assert_called_once_with("accuracy", 0.72)
+
+        # Test a method called by __getattr__ calls the corresponding classmethod of the mock project's class.
+        clearml_logger.current_logger()
+        mock_logger.current_logger.assert_called_once()
+
+
+def test_clearml_logger_get_task_bypass(dirname):
+
+    ClearMLLogger.set_bypass_mode(True)
+    with ClearMLLogger(output_uri=dirname) as clearml_logger:
+        task = clearml_logger.get_task()
+        # In bypass mode, there is no external communication so Task should not be created.
+        assert isinstance(task, clearml.Task) is False
+        assert "._Stub" in repr(task)
+
+
 @pytest.mark.distributed
 @pytest.mark.skipif(not idist.has_native_dist_support, reason="Skip if no native dist support")
 def test_distrib_gloo_cpu_or_gpu(distributed_context_single_node_gloo):