Skip to main content

在ClickHouse中应用Catboost模型

CatBoost 是一个由Yandex开发的开源免费机器学习库。

通过本篇文档,您将学会如何用SQL语句调用已经存放在Clickhouse中的预训练模型来预测数据。

为了在ClickHouse中应用CatBoost模型,需要进行如下步骤:

  1. 创建数据表.
  2. 将数据插入到表中.
  3. 将CatBoost集成到ClickHouse中 (可跳过)。
  4. 从SQL运行模型推断.

有关训练CatBoost模型的详细信息,请参阅 训练和模型应用.

您可以通过RELOAD MODELRELOAD MODELS语句来重载CatBoost模型。

先决条件

请先安装 Docker

!!! note "注" Docker 是一个软件平台,用户可以用Docker来创建独立于已有系统并集成了CatBoost和ClickHouse的容器。

在应用CatBoost模型之前:

1. 从容器仓库拉取示例docker镜像 (https://hub.docker.com/r/yandex/tutorial-catboost-clickhouse) :

$ 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 622e4d17945b 22 hours ago 1.37GB

3. 基于此镜像启动一个Docker容器:

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

1. 创建数据表

为训练样本创建ClickHouse表:

1. 在交互模式下启动ClickHouse控制台客户端:

$ clickhouse client

!!! note "注" ClickHouse服务器已经在Docker容器内运行。

2. 使用以下命令创建表:

:) 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 ORDER BY date

3. 从ClickHouse控制台客户端退出:

:) exit

2. 将数据插入到表中

插入数据:

1. 运行以下命令:

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

2. 在交互模式下启动ClickHouse控制台客户端:

$ clickhouse client

3. 确保数据已上传:

:) SELECT count() FROM amazon_train

SELECT count()
FROM amazon_train

+-count()-+
| 65538 |
+-------+

3. 将CatBoost集成到ClickHouse中

!!! note "注" 可跳过。 示例Docker映像已经包含了运行CatBoost和ClickHouse所需的所有内容。

为了将CatBoost集成进ClickHouse,需要进行如下步骤:

1. 构建评估库。

评估CatBoost模型的最快方法是编译 libcatboostmodel.<so|dll|dylib> 库文件.

有关如何构建库文件的详细信息,请参阅 CatBoost文件.

2. 创建一个新目录(位置与名称可随意指定), 如 data 并将创建的库文件放入其中。 示例Docker镜像已经包含了库 data/libcatboostmodel.so.

3. 创建一个新目录来放配置模型, 如 models.

4. 创建一个模型配置文件,如 models/amazon_model.xml.

5. 修改模型配置:

<models>
<model>
<!-- Model type. Now catboost only. -->
<type>catboost</type>
<!-- Model name. -->
<name>amazon</name>
<!-- Path to trained model. -->
<path>/home/catboost/tutorial/catboost_model.bin</path>
<!-- Update interval. -->
<lifetime>0</lifetime>
</model>
</models>

6. 将CatBoost库文件的路径和模型配置添加到ClickHouse配置:

<!-- File etc/clickhouse-server/config.d/models_config.xml. -->
<catboost_dynamic_library_path>/home/catboost/data/libcatboostmodel.so</catboost_dynamic_library_path>
<models_config>/home/catboost/models/*_model.xml</models_config>

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 会对多类别模型返回一个元组,其中包含每一类别的原始预测值。

执行预测:

:) 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()

原始文章