clearml-docs/docs/guides/frameworks/catboost/catboost.md

41 lines
1.8 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: 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 **> 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 **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)