Modify report_matplotlib_figure to Omit Iteration Value When iteration=None

[scott-kim94]

Proposal Summary

The report_matplotlib_figure method currently sets the iteration value to 0 when the iteration parameter is None. This results in an unnecessary display of "iteration 0". I propose that the method be modified so that if iteration is None, the iteration value should not be displayed.

Motivation

In many cases, users may not want to specify an iteration value when reporting a matplotlib figure. Setting the default iteration value to 0 can be misleading and clutter the report with unnecessary information. By omitting the iteration value when iteration=None, the reported plots will be cleaner and more accurate, reflecting the user's intention not to specify an iteration.

Related Discussion

N/A

[ainoam]

Thanks for suggesting @scott-kim94.

Without going into ClearML internals, do you mean that when a single plot is reported, with no iteration value, no iteration value should appear in the title?

[scott-kim94]

@ainoam

report_matplotlib_figure(
            title=f"Data Bias/{data_type}",
            series="Image Size Distribution",
            iteration=None,
            figure=plt,
            report_interactive=False,
        )

I saw your answer too late. I'm sorry.
Yes, that’s right.
In the case of a plot that has no correlation with iteration, iteration information is not required,
so the default value of 0 is output even though it is entered as None.

[ainoam]

@scott-kim94 Indeed this seems like a bug that has crept in - iteration should not show in UI in this case. We'll try to address in a near version.