diff --git a/docs/guides/frameworks/lightgbm/lightgbm_example.md b/docs/guides/frameworks/lightgbm/lightgbm_example.md new file mode 100644 index 00000000..94ed89ae --- /dev/null +++ b/docs/guides/frameworks/lightgbm/lightgbm_example.md @@ -0,0 +1,38 @@ +--- +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 > RESULTS > SCALARS**. + +![LightGBM scalars](../../../img/examples_lightgbm_scalars.png) + +## Hyperparameters + +ClearML automatically logs the configurations applied to LightGBM. They appear in **CONFIGURATIONS > HYPER PARAMETERS > GENERAL**. + +![LightGBM hyperparameters](../../../img/examples_lightgbm_config.png) + +## Artifacts + +Model artifacts associated with the experiment appear in the info panel of the **EXPERIMENTS** tab and in the info panel of the **MODELS** tab. + +![LightGBM model](../../../img/examples_lightgbm_model.png) + +## Console + +All other console output appears in **RESULTS > CONSOLE**. + +![LightGBM console](../../../img/examples_lightgbm_console.png) + + diff --git a/docs/img/examples_lightgbm_config.png b/docs/img/examples_lightgbm_config.png new file mode 100644 index 00000000..c6884d5d Binary files /dev/null and b/docs/img/examples_lightgbm_config.png differ diff --git a/docs/img/examples_lightgbm_console.png b/docs/img/examples_lightgbm_console.png new file mode 100644 index 00000000..8b910b07 Binary files /dev/null and b/docs/img/examples_lightgbm_console.png differ diff --git a/docs/img/examples_lightgbm_model.png b/docs/img/examples_lightgbm_model.png new file mode 100644 index 00000000..16e1d875 Binary files /dev/null and b/docs/img/examples_lightgbm_model.png differ diff --git a/docs/img/examples_lightgbm_scalars.png b/docs/img/examples_lightgbm_scalars.png new file mode 100644 index 00000000..f1c67c58 Binary files /dev/null and b/docs/img/examples_lightgbm_scalars.png differ diff --git a/sidebars.js b/sidebars.js index 64fdad40..4783dd03 100644 --- a/sidebars.js +++ b/sidebars.js @@ -68,6 +68,7 @@ module.exports = { { 'Keras': ['guides/frameworks/keras/allegro_clearml_keras_tb_example', 'guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard'] }, + {'LightGBM': ['guides/frameworks/lightgbm/lightgbm_example']}, {'Matplotlib': ['guides/frameworks/matplotlib/allegro_clearml_matplotlib_example', 'guides/frameworks/matplotlib/matplotlib_example']}, { 'Pytorch': ['guides/frameworks/pytorch/pytorch_distributed_example', 'guides/frameworks/pytorch/pytorch_matplotlib',