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

42 lines
1.6 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
2022-01-02 14:23:06 +00:00
title: XGBoost and scikit-learn
2021-05-13 23:48:51 +00:00
---
The [xgboost_sample.py](https://github.com/allegroai/clearml/blob/master/examples/frameworks/xgboost/xgboost_sample.py)
2022-01-13 07:42:36 +00:00
example demonstrates integrating ClearML into code that uses [XGBoost](https://xgboost.readthedocs.io/en/stable/).
2021-05-13 23:48:51 +00:00
2022-01-13 07:42:36 +00:00
The example does the following:
* Trains 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 using XGBoost
* Scores accuracy using scikit-learn
* ClearML automatically logs the input model registered by XGBoost, and the output model (and its checkpoints),
feature importance plot, and tree plot created with XGBoost.
* Creates an experiment named `XGBoost simple example`, which is associated with the `examples` project.
2021-05-13 23:48:51 +00:00
## Plots
2022-05-22 07:27:30 +00:00
The feature importance plot and tree plot appear in the project's page in the **ClearML web UI**, under
2021-05-13 23:48:51 +00:00
**PLOTS**.
![Feature importance plot](../../../img/examples_xgboost_sample_06.png)
![Tree plot](../../../img/examples_xgboost_sample_06a.png)
2021-05-13 23:48:51 +00:00
2021-05-18 22:31:01 +00:00
## Console
2021-05-13 23:48:51 +00:00
2022-05-22 07:27:30 +00:00
All other console output appear in **CONSOLE**.
2021-05-13 23:48:51 +00:00
![image](../../../img/examples_xgboost_sample_05.png)
## Artifacts
2022-01-13 07:42:36 +00:00
Models created by the experiment appear in the experiments **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using XGBoost.
2021-05-13 23:48:51 +00:00
![image](../../../img/examples_xgboost_sample_10.png)
2022-01-13 07:42:36 +00:00
Clicking on the model's name takes you to the [models page](../../../webapp/webapp_model_viewing.md), where you can
view the models details and access the model.
2021-05-13 23:48:51 +00:00
![image](../../../img/examples_xgboost_sample_03.png)