Add to_folder option for plots

Author: YoanSallami

README.md

@@ -282,7 +282,7 @@ async def main():
         epochs=epochs,
     )
 
-    filepath = synalinks.utils.plot_history(history)
+    synalinks.utils.plot_history(history)
 
 if __name__ == "__main__":
     asyncio.run(main())

coverage-badge.svg

@@ -98,6 +98,8 @@ exclude_lines = [
 ]
 omit = [
     "*/__init__.py",
+    "*/plot_*.py",
+    "*/*_visualization.py",
 ]
 
 [tool.coverage.run]

pyproject.toml

@@ -231,7 +231,6 @@ def summary(
         line_length=None,
         positions=None,
         print_fn=None,
-        return_string=False,
         expand_nested=False,
         show_trainable=False,
         module_range=None,
@@ -250,7 +249,6 @@ def summary(
                 It will be called on each line of the summary.
                 You can set it to a custom function
                 in order to capture the string summary.
-            return_string: If True, return the summary string instead of printing.
             expand_nested: Whether to expand the nested models.
                 Defaults to `False`.
             show_trainable: Whether to show if a module is trainable.
@@ -277,7 +275,6 @@ def summary(
             show_trainable=show_trainable,
             module_range=module_range,
         )
-        # TODO capture stdout and return the string
 
     def save(self, filepath, overwrite=True, **kwargs):
         """Saves a program as a `.json` file.

synalinks/src/programs/program.py

@@ -1,5 +1,6 @@
 # License Apache 2.0: (c) 2025 Yoan Sallami (Synalinks Team)
 
+import os
 import matplotlib.pyplot as plt
 from matplotlib.ticker import MaxNLocator
 
@@ -11,6 +12,7 @@
 def plot_history(
     history,
     to_file="training_history.png",
+    to_folder=None,
     xlabel="Epochs",
     ylabel="Scores",
     title="Training history",
@@ -47,8 +49,10 @@ def plot_history(
         ValueError: If there are unrecognized keyword arguments.
 
     Returns:
-        (IPython.display.Image): If running in a Jupyter notebook,
-            returns an IPython Image object for inline display.
+        (IPython.display.Image | marimo.Image | str): 
+            If running in a Jupyter notebook, returns an IPython Image object
+            for inline display. If running in a Marimo notebook returns a marimo image.
+            Otherwise returns the filepath where the image have been saved.
     """
 
     colors = generate_distinct_colors(len(history.history))
@@ -68,6 +72,8 @@ def plot_history(
     plt.ylim(0.0, 1.0)
     plt.legend()
     plt.grid(grid)
+    if to_folder:
+        to_file = os.path.join(to_folder, to_file)
     plt.savefig(to_file)
     plt.close()
     try:

synalinks/src/utils/plot_history.py

@@ -1,5 +1,6 @@
 # License Apache 2.0: (c) 2025 Yoan Sallami (Synalinks Team)
 
+import os
 import matplotlib.pyplot as plt
 
 from synalinks.src.api_export import synalinks_export
@@ -10,6 +11,7 @@
 def plot_metrics(
     metrics,
     to_file="evaluation_metrics.png",
+    to_folder=None,
     xlabel="Metrics",
     ylabel="Scores",
     title="Evaluation metrics",
@@ -42,8 +44,10 @@ def plot_metrics(
         ValueError: If there are unrecognized keyword arguments.
 
     Returns:
-        (IPython.display.Image): If running in a Jupyter notebook,
-            returns an IPython Image object for inline display.
+        (IPython.display.Image | marimo.Image | str): 
+            If running in a Jupyter notebook, returns an IPython Image object
+            for inline display. If running in a Marimo notebook returns a marimo image.
+            Otherwise returns the filepath where the image have been saved.
     """
 
     metric_names = list(metrics.keys())
@@ -60,6 +64,8 @@ def plot_metrics(
     plt.ylim(0.0, 1.0)
     plt.legend()
     plt.grid(grid)
+    if to_folder:
+        to_file = os.path.join(to_folder, to_file)
     plt.savefig(to_file)
     plt.close()
     try:

synalinks/src/utils/plot_metrics.py

@@ -331,6 +331,7 @@ def program_to_dot(
 def plot_program(
     program,
     to_file=None,
+    to_folder=None,
     show_schemas=False,
     show_module_names=False,
     rankdir="TB",
@@ -351,10 +352,10 @@ def plot_program(
         outputs=outputs,
     )
 
-    dot_img_file = '/tmp/program_1.png'
     synalinks.utils.plot_program(
         program,
-        to_file=dot_img_file,
+        to_file="program_1.png",
+        to_folder="/tmp",
         show_schemas=True,
         show_trainable=True,
     )
@@ -378,8 +379,10 @@ def plot_program(
         show_trainable (bool): whether to display if a module is trainable.
 
     Returns:
-        (IPython.display.Image): A Jupyter notebook Image object if Jupyter is installed.
-            This enables in-line display of the program plots in notebooks.
+        (IPython.display.Image | marimo.Image | str): 
+            If running in a Jupyter notebook, returns an IPython Image object
+            for inline display. If running in a Marimo notebook returns a marimo image.
+            Otherwise returns the filepath where the image have been saved.
     """
 
     if not to_file:
@@ -433,15 +436,17 @@ def plot_program(
         return
     dot = remove_unused_edges(dot)
     _, extension = os.path.splitext(to_file)
+    if to_folder:
+        to_file = os.path.join(to_folder, to_file)
     if not extension:
         extension = "png"
     else:
         extension = extension[1:]
     # Save image to disk.
     dot.write(to_file, format=extension)
-    # Return the image as a Jupyter Image object, to be displayed in-line.
+    # Return the image as a Jupyter Image object or Marimo Image object, to be displayed in-line.
     # Note that we cannot easily detect whether the code is running in a
-    # notebook, and thus we always return the Image if Jupyter is available.
+    # Jupyter notebook, and thus we always return the Image if Jupyter is available.
     if extension != "pdf":
         try:
             from IPython import display

synalinks/src/utils/program_visualization.py

@@ -286,7 +286,7 @@ def print_module(module, nested_level=0):
         console = rich.console.Console(highlight=False)
 
     # Print the to the console.
-    console.print(bold_text(f"Program: {rich.markup.escape(program.name)}"))
+    console.print(f"Program: {rich.markup.escape(program.name)}")
     console.print(f"description: '{rich.markup.escape(program.description)}'")
     console.print(table)
 

synalinks/src/utils/summary_utils.py

@@ -3,7 +3,7 @@
 from synalinks.src.api_export import synalinks_export
 
 # Unique source of truth for the version number.
-__version__ = "0.1.3001"
+__version__ = "0.1.3002"
 
 
 @synalinks_export("synalinks.version")