mirror of
https://github.com/clearml/clearml-docs
synced 2025-01-31 14:37:18 +00:00
88 lines
2.9 KiB
Markdown
88 lines
2.9 KiB
Markdown
---
|
|
title: HTML Reporting
|
|
---
|
|
|
|
The [html_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/html_reporting.py) example
|
|
demonstrates reporting local HTML files and HTML by URL using [`Logger.report_media()`](../../references/sdk/logger.md#report_media).
|
|
|
|
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` in the `examples` project.
|
|
|
|
|
|
|
|
## Reporting HTML URLs
|
|
|
|
Report HTML by URL using [`Logger.report_media()`](../../references/sdk/logger.md#report_media)'s `url` parameter.
|
|
|
|
See the example script's [`report_html_url`](https://github.com/allegroai/clearml/blob/master/examples/reporting/html_reporting.py#L16)
|
|
function, which reports the ClearML documentation's home page.
|
|
|
|
```python
|
|
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](#interactive-html)
|
|
* [Bokeh GroupBy HTML](#bokeh-groupby-html)
|
|
* [Bokeh Graph HTML](#bokeh-graph-html)
|
|
* [Bokeh Image HTML](#bokeh-image-html)
|
|
|
|
### Interactive HTML
|
|
|
|
See the example script's [`report_html_periodic_table`](https://github.com/allegroai/clearml/blob/master/examples/reporting/html_reporting.py#L26) function, which reports a file created from Bokeh sample data.
|
|
```python
|
|
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`](https://github.com/allegroai/clearml/blob/master/examples/reporting/html_reporting.py#L117) function, which reports a Pandas GroupBy with nested HTML, created from Bokeh sample data.
|
|
```python
|
|
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`](https://github.com/allegroai/clearml/blob/master/examples/reporting/html_reporting.py#L162) function, which reports a Bokeh plot created from Bokeh sample data.
|
|
|
|
```python
|
|
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`](https://github.com/allegroai/clearml/blob/master/examples/reporting/html_reporting.py#L195) function, which reports an image created from Bokeh sample data.
|
|
|
|
```python
|
|
Logger.current_logger().report_media(
|
|
title="html",
|
|
series="Spectral_html",
|
|
iteration=iteration,
|
|
local_path="image.html"
|
|
)
|
|
```
|