ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#901)

Browse Source
This commit is contained in:
pollfly
2024-08-12 16:04:50 +03:00
committed by GitHub
parent 3021efd45c
commit 8b94fa6c1a
17 changed files with 67 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/guides/reporting/html_reporting.md
View File

@@ -15,15 +15,15 @@ When the script runs, it creates an experiment named `html samples reporting` in
## Reporting HTML URLs
Report HTML by URL, using the [Logger.report_media](../../references/sdk/logger.md#report_media) method's `url` parameter.
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)
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(
"html",
"url_html",
title="html",
series="url_html",
iteration=iteration,
url="https://clear.ml/docs/latest/docs/index.html"
)
@@ -39,20 +39,23 @@ Report the following using the `Logger.report_media` parameter method `local_pat
### 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.
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(
"html", "periodic_html", iteration=iteration, local_path="periodic.html"
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.
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(
"html",
"pandas_groupby_nested_html",
title="html",
series="pandas_groupby_nested_html",
iteration=iteration,
local_path="bar_pandas_groupby_nested.html",
)
@@ -60,20 +63,26 @@ Logger.current_logger().report_media(
### 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.
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(
"html", "Graph_html", iteration=iteration, local_path="graph.html"
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.
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(
"html", "Spectral_html", iteration=iteration, local_path="image.html"
title="html",
series="Spectral_html",
iteration=iteration,
local_path="image.html"
)
```