mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Add CatBoost example docs (#210)
This commit is contained in:
parent
9f1c63ca15
commit
01c69bb3b4
40
docs/guides/frameworks/catboost/catboost.md
Normal file
40
docs/guides/frameworks/catboost/catboost.md
Normal 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**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Hyperparameters
|
||||||
|
ClearML automatically logs command line options defined with argparse. They appear in **CONFIGURATIONS > HYPER
|
||||||
|
PARAMETERS > Args**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Console
|
||||||
|
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS > CONSOLE**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Artifacts
|
||||||
|
Models created by the experiment appear in the experiment’s **ARTIFACTS** tab. ClearML automatically logs and tracks
|
||||||
|
models created using CatBoost.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Clicking on the model name takes you to the [model’s page](../../../webapp/webapp_model_viewing.md), where you can view
|
||||||
|
the model’s details and access the model.
|
||||||
|
|
||||||
|

|
BIN
docs/img/examples_catboost_artifacts.png
Normal file
BIN
docs/img/examples_catboost_artifacts.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 100 KiB |
BIN
docs/img/examples_catboost_configurations.png
Normal file
BIN
docs/img/examples_catboost_configurations.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 88 KiB |
BIN
docs/img/examples_catboost_console.png
Normal file
BIN
docs/img/examples_catboost_console.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 264 KiB |
BIN
docs/img/examples_catboost_model.png
Normal file
BIN
docs/img/examples_catboost_model.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 127 KiB |
BIN
docs/img/examples_catboost_scalars.png
Normal file
BIN
docs/img/examples_catboost_scalars.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 183 KiB |
@ -76,6 +76,7 @@ module.exports = {
|
|||||||
{'Docker': ['guides/docker/extra_docker_shell_script']},
|
{'Docker': ['guides/docker/extra_docker_shell_script']},
|
||||||
{'Frameworks': [
|
{'Frameworks': [
|
||||||
{'Autokeras': ['guides/frameworks/autokeras/integration_autokeras', 'guides/frameworks/autokeras/autokeras_imdb_example']},
|
{'Autokeras': ['guides/frameworks/autokeras/integration_autokeras', 'guides/frameworks/autokeras/autokeras_imdb_example']},
|
||||||
|
'guides/frameworks/catboost/catboost',
|
||||||
'guides/frameworks/fastai/fastai_with_tensorboard',
|
'guides/frameworks/fastai/fastai_with_tensorboard',
|
||||||
{'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']},
|
{'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']},
|
||||||
'guides/frameworks/lightgbm/lightgbm_example',
|
'guides/frameworks/lightgbm/lightgbm_example',
|
||||||
|
Loading…
Reference in New Issue
Block a user