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 Logger.report_media().

ClearML reports these HTML debug samples in the ClearML Web UI > task's DEBUG SAMPLES tab.

When the script runs, it creates a task named html samples reporting in the examples project.

Reporting HTML URLs

Report HTML by URL using Logger.report_media()'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(
    title="html", 
    series="url_html", 
    iteration=iteration, 
    url="https://clear.ml/docs/latest/docs/index.html"
)

Reporting HTML Local Files

Report the following using Logger.report_media()'s 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(
    title="html", 
    series="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(
    title="html",
    series="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(
    title="html", 
    series="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(
    title="html", 
    series="Spectral_html", 
    iteration=iteration, 
    local_path="image.html"
)