tensorboard process handling

Author: bartzbeielstein

pyproject.toml

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

src/spotPython/utils/tensorboard.py

@@ -0,0 +1,32 @@
+import subprocess
+
+
+def start_tensorboard() -> subprocess.Popen:
+    """Starts a tensorboard server in the background.
+
+    Returns:
+        process: The process of the tensorboard server.
+
+    Examples:
+        >>> process = start_tensorboard()
+
+    """
+    cmd = ["tensorboard", "--logdir=./runs"]
+    process = subprocess.Popen(cmd)
+    return process
+
+
+def stop_tensorboard(process) -> None:
+    """Stops a tensorboard server.
+
+    Args:
+        process: The process of the tensorboard server.
+
+    Returns:
+        None
+
+    Examples:
+        >>> process = start_tensorboard()
+        >>> stop_tensorboard(process)
+    """
+    process.terminate()