From 4331a1614f0ebbb8b23826e52e34b73d456614a5 Mon Sep 17 00:00:00 2001 From: Sergei Bocharov Date: Thu, 22 Aug 2019 08:45:45 +0300 Subject: [PATCH] Fixes after review --- .../functions/other_functions.md | 4 +-- ...boost-model.md => apply_catboost_model.md} | 34 +++++++------------ docs/en/solutions/index.md | 2 +- ...boost-model.md => apply_catboost_model.md} | 30 +++++++--------- docs/ru/solutions/index.md | 2 +- docs/toc_en.yml | 4 +-- docs/toc_ru.yml | 2 +- 7 files changed, 32 insertions(+), 46 deletions(-) rename docs/en/solutions/{apply-catboost-model.md => apply_catboost_model.md} (83%) rename docs/ru/solutions/{apply-catboost-model.md => apply_catboost_model.md} (85%) diff --git a/docs/en/query_language/functions/other_functions.md b/docs/en/query_language/functions/other_functions.md index b5b2320fa02..f6139741849 100644 --- a/docs/en/query_language/functions/other_functions.md +++ b/docs/en/query_language/functions/other_functions.md @@ -768,8 +768,8 @@ Gets data from [Join](../../operations/table_engines/join.md) tables using the s Only supports tables created with the `ENGINE = Join(ANY, LEFT, )` statement. -## modelEvaluate(model_name, ...) -Evaluate model. +## modelEvaluate(model_name, ...) {#function-modelevaluate} +Evaluate external model. Accepts a model name and model arguments. Returns Float64. ## throwIf(x\[, custom_message\]) diff --git a/docs/en/solutions/apply-catboost-model.md b/docs/en/solutions/apply_catboost_model.md similarity index 83% rename from docs/en/solutions/apply-catboost-model.md rename to docs/en/solutions/apply_catboost_model.md index d8dc9b309a7..d1d8859ddfc 100644 --- a/docs/en/solutions/apply-catboost-model.md +++ b/docs/en/solutions/apply_catboost_model.md @@ -4,10 +4,12 @@ To apply a CatBoost model in ClickHouse: -1. [Create a table for the train sample](#create-a-table). -1. [Insert the data to the table](#insert-the-data-to-the-table). -1. [Configure the model](#configure-the-model). -1. [Test the trained model](#test-the-trained-model). +1. [Create a table](#create-table). +2. [Insert the data to the table](#insert-the-data-to-the-table). +3. [Configure the model](#configure-the-model). +4. [Run the model inference from SQL](#run-the-model-inference). + +For more information about training CatBoost models, see [Training and applying models](https://catboost.ai/docs/features/training.html#training). ## Before you start {#before-you-start} @@ -41,7 +43,7 @@ $ docker run -it -p 8888:8888 yandex/tutorial-catboost-clickhouse > **Note:** Example running a Jupyter Notebook with this manual materials to [http://localhost:8888](http://localhost:8888). -## 1. Create a table {#create-a-table} +## 1. Create a table {#create-table} To create a ClickHouse table for the train sample: @@ -106,7 +108,7 @@ FROM amazon_train This step is optional: the Docker container contains all configuration files. -**1.** Create a config file (for example, `config_model.xml`) with the model configuration: +Create a config file (for example, `config_model.xml`) with the model configuration: ```xml @@ -125,22 +127,15 @@ This step is optional: the Docker container contains all configuration files. > **Note:** To show contents of the config file in the Docker container, run `cat models/amazon_model.xml`. -**2.** Add the following lines to the `/etc/clickhouse-server/config.xml` file: +The ClickHouse config file should already have this setting: ```xml -/home/catboost/.data/libcatboostmodel.so /home/catboost/models/*_model.xml ``` -> **Note:** To show contents of the ClickHouse config file in the Docker container, run `cat ../../etc/clickhouse-server/config.xml`. +To check it, run `tail ../../etc/clickhouse-server/config.xml`. -**3.** Restart ClickHouse server: - -```bash -$ sudo service clickhouse-server restart -``` - -## 4. Test the trained model {#test-the-trained-model} +## 4. Run the model inference from SQL {#run-the-model-inference} For test run the ClickHouse client `$ clickhouse client`. @@ -163,7 +158,7 @@ FROM amazon_train LIMIT 10 ``` -> **Note:** Function `modelEvaluate` returns tuple with per-class raw predictions for multiclass models. +> **Note:** Function [modelEvaluate](../query_language/functions/other_functions.md#function-modelevaluate) returns tuple with per-class raw predictions for multiclass models. - Let's predict probability: @@ -206,7 +201,4 @@ FROM ACTION AS tg FROM amazon_train ) -``` - - - +``` \ No newline at end of file diff --git a/docs/en/solutions/index.md b/docs/en/solutions/index.md index 3962e735440..617af5e4b25 100644 --- a/docs/en/solutions/index.md +++ b/docs/en/solutions/index.md @@ -2,4 +2,4 @@ Detailed step-by-step instructions that will help you solve various tasks using ClickHouse. -- [Applying a CatBoost model in ClickHouse](apply-catboost-model.md) \ No newline at end of file +- [Applying a CatBoost model in ClickHouse](apply_catboost_model.md) \ No newline at end of file diff --git a/docs/ru/solutions/apply-catboost-model.md b/docs/ru/solutions/apply_catboost_model.md similarity index 85% rename from docs/ru/solutions/apply-catboost-model.md rename to docs/ru/solutions/apply_catboost_model.md index 05da3862338..70f8563c393 100644 --- a/docs/ru/solutions/apply-catboost-model.md +++ b/docs/ru/solutions/apply_catboost_model.md @@ -4,10 +4,12 @@ Чтобы применить модель CatBoost в ClickHouse: -1. [Создайте таблицу для обучающей выборки](#create-a-table). -1. [Вставьте данные в таблицу](#insert-the-data-to-the-table). -1. [Настройте конфигурацию модели](#configure-the-model). -1. [Протестируйте обученную модель](#test-the-trained-model). +1. [Создайте таблицу](#create-table). +2. [Вставьте данные в таблицу](#insert-the-data-to-the-table). +3. [Настройте конфигурацию модели](#configure-the-model). +4. [Запустите вывод модели из SQL](#run-the-model-inference). + +Подробнее об обучении моделей в CatBoost, см. [Обучение и применение моделей](https://catboost.ai/docs/features/training.html#training). ## Подготовка к работе {#before-you-start} @@ -41,7 +43,7 @@ $ docker run -it -p 8888:8888 yandex/tutorial-catboost-clickhouse > **Примечание.** После запуска по адресу [http://localhost:8888](http://localhost:8888) будет доступен Jupyter Notebook с материалами данной инструкции. -## 1. Создайте таблицу {#create-a-table} +## 1. Создайте таблицу {#create-table} Чтобы создать таблицу в ClickHouse для обучающей выборки: @@ -106,7 +108,7 @@ FROM amazon_train Опциональный шаг: Docker-контейнер содержит все необходимые файлы конфигурации. -**1.** Создайте файл с конфигурацией модели (например, `config_model.xml`): +Создайте файл с конфигурацией модели (например, `config_model.xml`): ```xml @@ -125,22 +127,15 @@ FROM amazon_train > **Примечание.** Чтобы посмотреть конфигурационный файл в Docker-контейнере, выполните команду `cat models/amazon_model.xml`. -**2.** Добавьте следующие строки в файл `/etc/clickhouse-server/config.xml`: +В конфигурации ClickHouse уже прописан параметр: ```xml -/home/catboost/.data/libcatboostmodel.so /home/catboost/models/*_model.xml ``` -> **Примечание.** Чтобы посмотреть конфигурационный файл ClickHouse в Docker-контейнере, выполните команду `cat ../../etc/clickhouse-server/config.xml`. +Чтобы убедиться в этом, выполните команду `tail ../../etc/clickhouse-server/config.xml`. -**3.** Перезапустите ClickHouse-сервер: - -```bash -$ sudo service clickhouse-server restart -``` - -## 4. Протестируйте обученную модель {#test-the-trained-model} +## 4. Запустите вывод модели из SQL {#run-the-model-inference} Для тестирования запустите ClickHouse-клиент `$ clickhouse client`. @@ -206,5 +201,4 @@ FROM ACTION AS tg FROM amazon_train ) -``` - +``` \ No newline at end of file diff --git a/docs/ru/solutions/index.md b/docs/ru/solutions/index.md index 33f848c566a..ff01589373b 100644 --- a/docs/ru/solutions/index.md +++ b/docs/ru/solutions/index.md @@ -2,4 +2,4 @@ Подробные пошаговые инструкции, которые помогут вам решать различные задачи с помощью ClickHouse. -- [Применение модели CatBoost в ClickHouse](apply-catboost-model.md) \ No newline at end of file +- [Применение модели CatBoost в ClickHouse](apply_catboost_model.md) \ No newline at end of file diff --git a/docs/toc_en.yml b/docs/toc_en.yml index 42068dd35f1..c8bf7e7c6c7 100644 --- a/docs/toc_en.yml +++ b/docs/toc_en.yml @@ -204,9 +204,9 @@ nav: - 'clickhouse-copier': 'operations/utils/clickhouse-copier.md' - 'clickhouse-local': 'operations/utils/clickhouse-local.md' -- 'Solution tutorials': +- 'Solution Tutorials': - 'Overview': 'solutions/index.md' - - 'Applying a CatBoost model in ClickHouse': 'solutions/apply-catboost-model.md' + - 'Applying CatBoost Models': 'solutions/apply_catboost_model.md' - 'Development': - 'hidden': 'development/index.md' diff --git a/docs/toc_ru.yml b/docs/toc_ru.yml index 3f3d1990621..d652109230f 100644 --- a/docs/toc_ru.yml +++ b/docs/toc_ru.yml @@ -205,7 +205,7 @@ nav: - 'Сценарии использования': - 'Обзор': 'solutions/index.md' - - 'Применение модели CatBoost в ClickHouse': 'solutions/apply-catboost-model.md' + - 'Применение CatBoost моделей': 'solutions/apply_catboost_model.md' - 'F.A.Q.': - 'Общие вопросы': 'faq/general.md'