clearml-docs/docs/guides/frameworks/lightgbm/lightgbm_example.md
2023-08-09 13:37:16 +03:00

40 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: LightGBM
---
The [lightgbm_example](https://github.com/allegroai/clearml/blob/master/examples/frameworks/lightgbm/lightgbm_example.py)
script demonstrates the integration of ClearML into code that uses LightGBM.
The example script does the following:
* Creates a dataset for LightGBM to train a model
* Specifies configuration which are automatically captured by ClearML
* Saves model which ClearML automatically captures
* Creates an experiment named `LightGBM`, which is associated with the `examples` project.
## Scalars
The scalars logged in the experiment can be visualized in a plot, which appears in the ClearML web UI, in the **experiment's page > SCALARS**.
![LightGBM scalars](../../../img/examples_lightgbm_scalars.png)
## Hyperparameters
ClearML automatically logs the configurations applied to LightGBM. They appear in **CONFIGURATIONS > HYPERPARAMETERS > GENERAL**.
![LightGBM hyperparameters](../../../img/examples_lightgbm_config.png)
## Artifacts
Models created by the experiment appear in the experiments **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using LightGBM.
![LightGBM model](../../../img/examples_lightgbm_model.png)
## Console
All other console output appears in **CONSOLE**.
![LightGBM console](../../../img/examples_lightgbm_console.png)