clearml-docs/docs/guides/reporting/html_reporting.md

title
HTML Reporting

The html_reporting.py example demonstrates reporting local HTML files and HTML by URL, using the Logger.report_media method.

ClearML reports these HTML debug samples in the ClearML Web UI > experiment details > DEBUG SAMPLES tab.

When the script runs, it creates an experiment named html samples reporting, which is associated with the examples project.

Reporting HTML URLs

Report HTML by URL, using the Logger.report_media method's url parameter.

See the example script's report_html_url function, which reports the ClearML documentation's home page.

Logger.current_logger().report_media(
    "html", 
    "url_html", 
    iteration=iteration, 
    url="https://clear.ml/docs/latest/docs/index.html"
)

Reporting HTML Local Files

Report the following using the Logger.report_media parameter method local_path parameter:

• Interactive HTML
• Bokeh GroupBy HTML
• Bokeh Graph HTML
• Bokeh Image HTML

Interactive HTML

See the example script's report_html_periodic_table function, which reports a file created from Bokeh sample data.

Logger.current_logger().report_media(
    "html", "periodic_html", iteration=iteration, local_path="periodic.html"
)

Bokeh GroupBy HTML

See the example script's report_html_groupby function, which reports a Pandas GroupBy with nested HTML, created from Bokeh sample data.

Logger.current_logger().report_media(
    "html",
    "pandas_groupby_nested_html",
    iteration=iteration,
    local_path="bar_pandas_groupby_nested.html",
)

Bokeh Graph HTML

See the example script's report_html_graph function, which reports a Bokeh plot created from Bokeh sample data.

Logger.current_logger().report_media(
    "html", "Graph_html", iteration=iteration, local_path="graph.html"
)

Bokeh Image HTML

See the example script's report_html_image function, which reports an image created from Bokeh sample data.

Logger.current_logger().report_media(
    "html", "Spectral_html", iteration=iteration, local_path="image.html"
)