Add Logger.report_matplotlib_figure() with examples

examples/frameworks/matplotlib/matplotlib_example.py

@@ -8,30 +8,39 @@ from trains import Task
 
 task = Task.init(project_name='examples', task_name='Matplotlib example')
 
-# create plot
+# Create a plot
 N = 50
 x = np.random.rand(N)
 y = np.random.rand(N)
 colors = np.random.rand(N)
 area = (30 * np.random.rand(N))**2  # 0 to 15 point radii
 plt.scatter(x, y, s=area, c=colors, alpha=0.5)
+# Plot will be reported automatically
 plt.show()
 
-# create another plot - with a name
+# Alternatively, in order to report the plot with a more meaningful title/series and iteration number
+area = (40 * np.random.rand(N))**2
+plt.scatter(x, y, s=area, c=colors, alpha=0.5)
+task.logger.report_matplotlib_figure(title="My Plot Title", series="My Plot Series", iteration=10, figure=plt)
+
+# Create another plot - with a name
 x = np.linspace(0, 10, 30)
 y = np.sin(x)
 plt.plot(x, y, 'o', color='black')
+# Plot will be reported automatically
 plt.show()
 
-# create image plot
+# Create image plot
 m = np.eye(256, 256, dtype=np.uint8)
 plt.imshow(m)
+# Plot will be reported automatically
 plt.show()
 
-# create image plot - with a name
+# Create image plot - with a name
 m = np.eye(256, 256, dtype=np.uint8)
 plt.imshow(m)
 plt.title('Image Title')
+# Plot will be reported automatically
 plt.show()
 
 sns.set(style="darkgrid")
@@ -41,6 +50,7 @@ fmri = sns.load_dataset("fmri")
 sns.lineplot(x="timepoint", y="signal",
              hue="region", style="event",
              data=fmri)
+# Plot will be reported automatically
 plt.show()
 
 print('This is a Matplotlib & Seaborn example')