The jupyter_logging_example.ipynb script demonstrates the integration of ClearML explicit reporting running in a Jupyter Notebook. All ClearML explicit reporting works with Jupyter Notebook.
This example includes several types of explicit reporting, including:
- Some plots
clearml GitHub repository, this example includes a clickable icon to open the notebook in Google Colab.
To reports scalars, call the Logger.report_scalar method. The scalar plots appear in the web UI in RESULTS > SCALARS.
Plots appear in RESULTS > PLOTS.
Report 2D scatter plots by calling the Logger.report_scatter2d method.
mode parameter to plot data points as markers, or both lines and markers.
To plot a series as a 3-dimensional scatter plot, use the Logger.report_scatter3d method.
To plot a series as a surface plot, use the Logger.report_surface method.
Report confusion matrices by calling the Logger.report_matrix method.
Report histograms by calling the Logger.report_histogram
method. To report more than one series on the same plot, use the same
Report audio, HTML, image, and video by calling the Logger.report_media
method using the
local_path parameter. They appear in RESULTS > DEBUG SAMPLES.
The media for these examples is downloaded using the StorageManager.get_local_copy method.
For example, to download an image:
Report text messages by calling the Logger.report_text.