Add CatBoost example docs (#210)

This commit is contained in:
pollfly 2022-03-20 15:41:28 +02:00 committed by GitHub
parent 9f1c63ca15
commit 01c69bb3b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 41 additions and 0 deletions

View File

@ -0,0 +1,40 @@
---
title: CatBoost
---
The [catboost_example.py](https://github.com/allegroai/clearml/blob/master/examples/frameworks/catboost/catboost_example.py)
example demonstrates the integration of ClearML into code that uses [CatBoost](https://catboost.ai).
The example script does the following:
* Trains a simple deep neural network on the CatBoost built-in [msrank](https://catboost.ai/en/docs/concepts/python-reference_datasets_msrank)
dataset.
* Creates an experiment named `CatBoost simple example` in the `examples` project
* ClearML automatically logs argparse command line options, and models and metrics logged by CatBoost
## Scalars
ClearML automatically captures scalars logged by CatBoost. These scalars can be visualized in plots, which appear in the
[ClearML web UI](../../../webapp/webapp_overview.md), in the experiment's page **> RESULTS > SCALARS**.
![Experiment scalars](../../../img/examples_catboost_scalars.png)
## Hyperparameters
ClearML automatically logs command line options defined with argparse. They appear in **CONFIGURATIONS > HYPER
PARAMETERS > Args**.
![Experiment hyperparameters](../../../img/examples_catboost_configurations.png)
## Console
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS > CONSOLE**.
![Experiment console](../../../img/examples_catboost_console.png)
## Artifacts
Models created by the experiment appear in the experiments **ARTIFACTS** tab. ClearML automatically logs and tracks
models created using CatBoost.
![Experiment artifacts](../../../img/examples_catboost_artifacts.png)
Clicking on the model name takes you to the [models page](../../../webapp/webapp_model_viewing.md), where you can view
the models details and access the model.
![Model page](../../../img/examples_catboost_model.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 264 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

View File

@ -76,6 +76,7 @@ module.exports = {
{'Docker': ['guides/docker/extra_docker_shell_script']},
{'Frameworks': [
{'Autokeras': ['guides/frameworks/autokeras/integration_autokeras', 'guides/frameworks/autokeras/autokeras_imdb_example']},
'guides/frameworks/catboost/catboost',
'guides/frameworks/fastai/fastai_with_tensorboard',
{'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']},
'guides/frameworks/lightgbm/lightgbm_example',