tensorboard handling

Author: bartzbeielstein

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spotpython"
-version = "0.14.63"
+version = "0.14.64"
 authors = [
   { name="T. Bartz-Beielstein", email="tbb@bartzundbartz.de" }
 ]

src/spotPython/utils/init.py

@@ -74,6 +74,8 @@ def fun_control_init(
     target_column=None,
     target_type=None,
     task=None,
+    tensorboard_start=False,
+    tensorboard_stop=False,
     test=None,
     test_seed=1234,
     test_size=0.4,
@@ -228,6 +230,10 @@ def fun_control_init(
             Default is None.
         TENSORBOARD_CLEAN (bool):
             Whether to clean (delete) the tensorboard folder or not. Default is False.
+        tensorboard_start (bool):
+            Whether to start the tensorboard or not. Default is False.
+        tensorboard_stop (bool):
+            Whether to stop the tensorboard or not. Default is False.
         test (object):
             The test data set for spotRiver. Default is None.
         test_seed (int):
@@ -340,6 +346,7 @@ def fun_control_init(
         "DATASET_PATH": DATASET_PATH,
         "RESULTS_PATH": RESULTS_PATH,
         "TENSORBOARD_PATH": TENSORBOARD_PATH,
+        "TENSORBOARD_CLEAN": TENSORBOARD_CLEAN,
         "_L_in": _L_in,
         "_L_out": _L_out,
         "_torchmetric": _torchmetric,
@@ -403,6 +410,8 @@ def fun_control_init(
         "target_column": target_column,
         "target_type": target_type,
         "task": task,
+        "tensorboard_start": tensorboard_start,
+        "tensorboard_stop": tensorboard_stop,
         "test": test,
         "test_seed": test_seed,
         "test_size": test_size,

src/spotPython/utils/tensorboard.py

@@ -8,6 +8,7 @@ def start_tensorboard() -> subprocess.Popen:
         process: The process of the tensorboard server.
 
     Examples:
+        >>> from spotPython.utils.tensorboard import start_tensorboard
         >>> process = start_tensorboard()
 
     """
@@ -17,17 +18,22 @@ def start_tensorboard() -> subprocess.Popen:
 
 
 def stop_tensorboard(process) -> None:
-    """Stops a tensorboard server.
+    """
+    Stops a tensorboard server if the process exists.
 
     Args:
-        process (subprocess.Popen):
-            The process of the tensorboard server.
+        process (subprocess.Popen): The process of the tensorboard server.
 
     Returns:
         None
 
     Examples:
+        >>> from spotPython.utils.tensorboard import start_tensorboard, stop_tensorboard
         >>> process = start_tensorboard()
         >>> stop_tensorboard(process)
     """
-    process.terminate()
+    if process is not None and process.poll() is None:
+        process.terminate()
+        process.wait()  # Ensure the process has terminated
+    else:
+        print("No active tensorboard process found or the process is already terminated.")

test/test_tensorboard_start_stop.py

@@ -0,0 +1,57 @@
+from spotPython.utils.tensorboard import start_tensorboard, stop_tensorboard
+
+import subprocess
+from unittest.mock import patch, MagicMock
+import pytest
+
+
+@patch("subprocess.Popen")
+def test_start_tensorboard(mock_popen):
+    # Arrange
+    mock_process = MagicMock()
+    mock_popen.return_value = mock_process
+
+    # Act
+    process = start_tensorboard()
+
+    # Assert
+    mock_popen.assert_called_once_with(["tensorboard", "--logdir=./runs"])
+    assert process == mock_process
+
+
+@patch("subprocess.Popen")
+def test_stop_tensorboard_active_process(mock_popen):
+    # Arrange
+    mock_process = MagicMock()
+    mock_process.poll.return_value = None  # Simulate that the process is still running
+
+    # Act
+    stop_tensorboard(mock_process)
+
+    # Assert
+    mock_process.terminate.assert_called_once()
+    mock_process.wait.assert_called_once()
+
+
+@patch("subprocess.Popen")
+def test_stop_tensorboard_no_process(mock_popen):
+    # Arrange
+    mock_process = MagicMock()
+    mock_process.poll.return_value = 0  # Simulate that the process is already terminated
+
+    # Act
+    stop_tensorboard(mock_process)
+
+    # Assert
+    mock_process.terminate.assert_not_called()
+    mock_process.wait.assert_not_called()
+
+
+@patch("subprocess.Popen")
+def test_stop_tensorboard_no_process_provided(mock_popen):
+    # Act
+    stop_tensorboard(None)
+
+    # Assert
+    # Nothing to assert because the function should just print a message, but ensuring no errors
+    assert True