ray.train.lightgbm.LightGBMTrainer#

class ray.train.lightgbm.LightGBMTrainer(*args, **kwargs)[源代码]#

基类：LightGBMTrainer

用于数据并行 LightGBM 训练的训练器。

这个训练器使用多个 Ray 角色以分布式方式运行 LightGBM 训练循环。

如果你想利用 LightGBM 对分类数据类型的内置处理功能，可以考虑应用 Categorizer 预处理器来设置数据集中的 dtypes。

备注

LightGBMTrainer 不会修改或改变 LightGBM 分布式训练算法的运行方式。Ray 仅提供编排、数据摄取和容错功能。有关 LightGBM 分布式训练的更多信息，请参阅 LightGBM 文档。

示例

import ray

from ray.train.lightgbm import LightGBMTrainer
from ray.train import ScalingConfig

train_dataset = ray.data.from_items(
    [{"x": x, "y": x + 1} for x in range(32)]
)
trainer = LightGBMTrainer(
    label_column="y",
    params={"objective": "regression"},
    scaling_config=ScalingConfig(num_workers=3),
    datasets={"train": train_dataset},
)
result = trainer.fit()
参数:

  • datasets – 用于训练和验证的 Ray 数据集。必须包含一个表示训练数据集的“train”键。所有非训练数据集将作为单独的验证集使用，每个验证集报告一个单独的指标。

  • label_column – 标签列的名称。训练数据集中必须存在具有此名称的列。

  • params – 传递给 lightgbm.train() 的 LightGBM 训练参数。有关可能的参数列表，请参阅 LightGBM 文档。

  • num_boost_round – 目标提升迭代次数（模型中的树）。请注意，与 lightgbm.train 不同，这是目标树的数量，这意味着如果你设置 num_boost_round=10 并传递一个已经训练了5次迭代的模型，它将再训练5次迭代，而不是再训练10次。

  • scaling_config – 数据并行训练的配置方式。

  • run_config – 训练运行的配置。

  • resume_from_checkpoint – 用于从中恢复训练的检查点。

  • metadata – 应在此 Trainer 保存的检查点中通过 checkpoint.get_metadata() 提供的字典。必须是 JSON 可序列化的。

  • **train_kwargs – 传递给 lightgbm.train() 函数的额外关键字参数。

PublicAPI (测试版): 此API目前处于测试阶段，在成为稳定版本之前可能会发生变化。

方法

as_trainable

将自身转换为 tune.Trainable 类。

can_restore

检查给定目录是否包含一个可恢复的 Train 实验。

fit

运行训练。

get_dataset_config

返回此训练器的最终数据集配置的副本。

get_model

检索存储在此检查点中的 LightGBM 模型。

preprocess_datasets

已弃用。

restore

从之前中断/失败的运行中恢复一个 DataParallelTrainer。

setup

在调用 fit() 时执行初始设置的 Trainer。