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

53 lines
1.6 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
title: Tables Reporting (Pandas and CSV Files)
---
The [pandas_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/pandas_reporting.py) example demonstrates reporting tabular data from Pandas DataFrames and CSV files as tables.
2022-03-13 13:07:06 +00:00
ClearML reports these tables in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **PLOTS**
2021-05-13 23:48:51 +00:00
sub-tab.
2022-03-13 13:07:06 +00:00
When the script runs, it creates an experiment named `table reporting`, which is associated with the `examples` project.
2021-05-13 23:48:51 +00:00
2021-09-09 10:17:46 +00:00
## Reporting Pandas DataFrames as Tables
2021-05-13 23:48:51 +00:00
Report Pandas DataFrames by calling the [Logger.report_table](../../references/sdk/logger.md#report_table)
method, and providing the DataFrame in the `table_plot` parameter.
2021-12-14 13:12:30 +00:00
```python
# Report table - DataFrame with index
df = pd.DataFrame(
{
"num_legs": [2, 4, 8, 0],
"num_wings": [2, 0, 0, 0],
"num_specimen_seen": [10, 2, 1, 8],
},
index=["falcon", "dog", "spider", "fish"],
)
df.index.name = "id"
Logger.current_logger().report_table(
"table pd",
"PD with index",
iteration=iteration,
table_plot=df
)
```
2021-05-13 23:48:51 +00:00
![image](../../img/examples_reporting_12.png)
2021-09-09 10:17:46 +00:00
## Reporting CSV Files as Tables
2021-05-13 23:48:51 +00:00
Report CSV files by providing the URL location of the CSV file in the `url` parameter. For a local CSV file, use the `csv` parameter.
2021-12-14 13:12:30 +00:00
```python
# Report table - CSV from path
csv_url = "https://raw.githubusercontent.com/plotly/datasets/master/Mining-BTC-180.csv"
Logger.current_logger().report_table(
"table csv",
"remote csv",
iteration=iteration,
url=csv_url
)
```
2021-05-13 23:48:51 +00:00
![image](../../img/examples_reporting_11.png)