ClickHouse/docs/ru/guides/apply_catboost_model.md

Применение модели CatBoost в ClickHouse

CatBoost — открытая программная библиотека разработанная компанией Яндекс для машинного обучения, использующая схему градиентного бустинга.

С помощью этой инструкции вы научитесь применять предобученные модели в ClickHouse: в результате вы запустите вывод модели из SQL.

Чтобы применить модель CatBoost в ClickHouse:

1. Создайте таблицу.
2. Вставьте данные в таблицу.
3. Настройте конфигурацию модели.
4. Запустите вывод модели из SQL.

Подробнее об обучении моделей в CatBoost, см. Обучение и применение моделей.

Перед началом работы

Если у вас еще нет Docker, установите его.

!!! note "Примечание" Docker – это программная платформа для создания контейнеров, которые изолируют установку CatBoost и ClickHouse от остальной части системы.

Перед применением модели CatBoost:

1. Скачайте Docker-образ из реестра:

$ docker pull yandex/tutorial-catboost-clickhouse

Данный Docker-образ содержит все необходимое для запуска CatBoost и ClickHouse: код, среду выполнения, библиотеки, переменные окружения и файлы конфигурации.

2. Проверьте, что Docker-образ успешно скачался:

$ docker image ls
REPOSITORY                            TAG                 IMAGE ID            CREATED             SIZE
yandex/tutorial-catboost-clickhouse   latest              3e5ad9fae997        19 months ago       1.58GB

3. Запустите Docker-контейнер основанный на данном образе:

$ docker run -it -p 8888:8888 yandex/tutorial-catboost-clickhouse

4. Удалите старые версии СlickHouse:

$ sudo apt-get purge clickhouse-server-base
$ sudo apt-get purge clickhouse-server-common
$ sudo apt-get autoremove

5. Проверьте успешность удаления:

dpkg -l | grep clickhouse-server

6. Установите последние версии пакетов:

$ sudo apt-get install dirmngr
$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv E0C56BD4

$ echo "deb http://repo.yandex.ru/clickhouse/deb/stable/ main/" | sudo tee /etc/apt/sources.list.d/clickhouse.list
$ sudo apt-get update

$ sudo apt-get install -y clickhouse-server clickhouse-client

$ sudo service clickhouse-server start
$ clickhouse-client

См. подробное описание в Быстром старте.

1. Создайте таблицу

Чтобы создать таблицу в ClickHouse для обучающей выборки:

1. Запустите ClickHouse-клиент:

$ clickhouse client

!!! note "Примечание" ClickHouse-сервер уже запущен внутри Docker-контейнера.

2. Создайте таблицу в ClickHouse с помощью следующей команды:

:) CREATE TABLE amazon_train
(
    date Date MATERIALIZED today(), 
    ACTION UInt8, 
    RESOURCE UInt32, 
    MGR_ID UInt32, 
    ROLE_ROLLUP_1 UInt32, 
    ROLE_ROLLUP_2 UInt32, 
    ROLE_DEPTNAME UInt32, 
    ROLE_TITLE UInt32, 
    ROLE_FAMILY_DESC UInt32, 
    ROLE_FAMILY UInt32, 
    ROLE_CODE UInt32
)
ENGINE = MergeTree(date, date, 8192)

2. Вставьте данные в таблицу

Чтобы вставить данные:

1. Выйдите из клиента ClickHouse:

:) exit

2. Загрузите данные:

$ clickhouse client --host 127.0.0.1 --query 'INSERT INTO amazon_train FORMAT CSVWithNames' < ~/amazon/train.csv

3. Проверьте, что данные действительно загрузились:

$ clickhouse client
:) SELECT count() FROM amazon_train

SELECT count()
FROM amazon_train

+-count()-+
|   32769 |
+---------+

3. Настройте конфигурацию модели

Опциональный шаг: Docker-контейнер содержит все необходимые файлы конфигурации.

Создайте файл с конфигурацией модели в папке models (например, models/config_model.xml):

<models>
    <model>
        <!-- Тип модели. В настоящий момент ClickHouse предоставляет только модель catboost. -->
        <type>catboost</type>
        <!-- Имя модели. -->
        <name>amazon</name>
        <!-- Путь к обученной модели. -->
        <path>/home/catboost/tutorial/catboost_model.bin</path>
        <!-- Интервал обновления. -->
        <lifetime>0</lifetime>
    </model>
</models>

!!! note "Примечание" Чтобы посмотреть конфигурационный файл в Docker-контейнере, выполните команду cat models/amazon_model.xml.

В конфигурации ClickHouse уже прописан параметр:

// ../../etc/clickhouse-server/config.xml
<models_config>/home/catboost/models/*_model.xml</models_config>

Чтобы убедиться в этом, выполните команду tail ../../etc/clickhouse-server/config.xml.

4. Запустите вывод модели из SQL

Для тестирования запустите ClickHouse-клиент $ clickhouse client.

Проверьте, что модель работает:

:) SELECT 
    modelEvaluate('amazon', 
                RESOURCE,
                MGR_ID,
                ROLE_ROLLUP_1,
                ROLE_ROLLUP_2,
                ROLE_DEPTNAME,
                ROLE_TITLE,
                ROLE_FAMILY_DESC,
                ROLE_FAMILY,
                ROLE_CODE) > 0 AS prediction, 
    ACTION AS target
FROM amazon_train
LIMIT 10

!!! note "Примечание" Функция modelEvaluate возвращает кортежи (tuple) с исходными прогнозами по классам для моделей с несколькими классами.

Спрогнозируйте вероятность:

:) SELECT 
    modelEvaluate('amazon', 
                RESOURCE,
                MGR_ID,
                ROLE_ROLLUP_1,
                ROLE_ROLLUP_2,
                ROLE_DEPTNAME,
                ROLE_TITLE,
                ROLE_FAMILY_DESC,
                ROLE_FAMILY,
                ROLE_CODE) AS prediction,
    1. / (1 + exp(-prediction)) AS probability, 
    ACTION AS target
FROM amazon_train
LIMIT 10

!!! note "Примечание" Подробнее про функцию exp().

Посчитайте логистическую функцию потерь (LogLoss) на всей выборке:

:) SELECT -avg(tg * log(prob) + (1 - tg) * log(1 - prob)) AS logloss
FROM 
(
    SELECT 
        modelEvaluate('amazon', 
                    RESOURCE,
                    MGR_ID,
                    ROLE_ROLLUP_1,
                    ROLE_ROLLUP_2,
                    ROLE_DEPTNAME,
                    ROLE_TITLE,
                    ROLE_FAMILY_DESC,
                    ROLE_FAMILY,
                    ROLE_CODE) AS prediction,
        1. / (1. + exp(-prediction)) AS prob, 
        ACTION AS tg
    FROM amazon_train
)

!!! note "Примечание" Подробнее про функции avg(), log().