clearml-docs/docs/guides/frameworks/xgboost/xgboost_metrics.md

34 lines
1.5 KiB
Markdown
Raw Normal View History

2022-01-02 14:23:06 +00:00
---
title: XGBoost Metric Reporting
---
The [xgboost_metrics.py](https://github.com/allegroai/clearml/blob/master/examples/frameworks/xgboost/xgboost_metrics.py)
example demonstrates the integration of ClearML into code that uses XGBoost to train a network on the scikit-learn [iris](https://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_iris.html#sklearn.datasets.load_iris)
classification dataset. ClearML automatically captures models and scalars logged with XGBoost.
When the script runs, it creates a ClearML experiment named `xgboost metric auto reporting`, which is associated with
the `examples` project.
## Scalars
ClearML automatically captures scalars logged with XGBoost, which can be visualized in plots in the
2022-05-22 07:27:30 +00:00
ClearML WebApp, in the experiment's **SCALARS** page.
2022-01-02 14:23:06 +00:00
![Scalars](../../../img/examples_xgboost_metric_scalars.png)
## Models
ClearML automatically captures the model logged using the `xgboost.save` method, and saves it as an artifact.
View saved snapshots in the experiment's **ARTIFACTS** tab.
![Artifacts tab](../../../img/examples_xgboost_metric_artifacts.png)
To view the model details, click the model name in the **ARTIFACTS** page, which will open the model's info tab. Alternatively, download the model.
![Model info panel](../../../img/examples_xgboost_metric_model.png)
## Console
2022-05-22 07:27:30 +00:00
All console output during the scripts execution appears in the experiments **CONSOLE** page.
2022-01-02 14:23:06 +00:00
![Console output](../../../img/examples_xgboost_metric_console.png)