ai.onnx.ml - 树集成¶

TreeEnsemble - 5 (ai.onnx.ml)¶

版本¶

名称: TreeEnsemble (GitHub)
领域: ai.onnx.ml
since_version: 5
函数: False
support_level: SupportType.COMMON
形状推断: True

此版本的运算符自ai.onnx.ml的第5版起可用。

摘要¶

树集成操作符。返回批次中每个输入的回归值。输入具有维度 [N, F]，其中 N 是输入批次大小，F 是输入特征的数量。输出具有维度 [N, num_targets]，其中 N 是批次大小，num_targets 是目标数量，这是一个可配置的属性。

此属性的编码沿着内部节点和树的叶子进行分割。值得注意的是，带有前缀nodes_*的属性与内部节点相关联，而带有前缀leaf_*的属性与叶子相关联。属性nodes_*必须具有相同的长度，并编码一个元组序列，这是通过取给定位置的所有nodes_*字段来定义的。

所有以leaf_*为前缀的字段代表树的叶子，同样定义了叶子的元组，并且必须具有相同的长度。

此操作符可用于实现之前的TreeEnsembleRegressor和TreeEnsembleClassifier节点。 TreeEnsembleRegressor节点直接映射到此节点，并需要更改节点的表示方式。 TreeEnsembleClassifier节点可以通过在此节点后添加一个ArgMax节点来确定顶级类别来实现。为了编码类别标签，可以使用LabelEncoder或GatherND操作符。

属性¶

aggregate_function - INT (默认值为 '1'):

定义如何聚合目标中的叶值。
其中之一是‘AVERAGE’ (0) ‘SUM’ (1) ‘MIN’ (2) ‘MAX (3) 默认为‘SUM’ (1)
leaf_targetids - INTS (必填) :

该叶子节点贡献的目标索引（必须在范围 [0, n_targets) 内）。
leaf_weights - 张量 (必填) :

每个叶子的权重。
membership_values - TENSOR :

用于测试每个集合成员节点的成员资格。按照node_modes中‘BRANCH_MEMBER’模式出现的顺序，列出所有要再次测试的成员，由NaN分隔。将具有与模式为‘BRANCH_MEMBER’的节点相同数量的值集。如果节点不包含任何‘BRANCH_MEMBER’节点，则可以省略此部分。
n_targets - INT :

目标的总数。
nodes_falseleafs - INTS（必填）：

1 如果每个节点的假分支是叶子节点，0 如果是内部节点。要表示一个只有叶子节点的树（只有一个节点），可以通过一个 nodes_* 条目来实现，其中真分支和假分支都引用同一个 leaf_* 条目
nodes_falsenodeids - INTS（必填）：

如果 nodes_falseleafs 在某个条目中为 false，这表示假分支节点的位置。这个位置可以用来索引到 nodes_* 条目。如果 nodes_falseleafs 为 false，则它是 leaf_* 属性的索引。
nodes_featureids - INTS（必填）：

每个节点的特征ID。
nodes_hitrates - TENSOR :

每个节点的流行度，用于性能分析，可以省略。
nodes_missing_value_tracks_true - INTS :

对于每个节点，定义在存在NaN输入特征时是否遵循真分支（如果属性值为1）或假分支（如果属性值为0）。此属性可以保持未定义状态，所有节点的默认值为假（0）。
nodes_modes - TENSOR（必填）：

节点执行的比较操作。这被编码为一个枚举，包括0（‘BRANCH_LEQ’）、1（‘BRANCH_LT’）、2（‘BRANCH_GTE’）、3（‘BRANCH_GT’）、4（‘BRANCH_EQ’）、5（‘BRANCH_NEQ’）和6（‘BRANCH_MEMBER’）。请注意，这是一个uint8类型的张量。
nodes_splits - TENSOR (必填) :

对于模式不是‘BRANCH_MEMBER’的每个节点，用于进行分割的阈值。
nodes_trueleafs - INTS (必填) :

1 如果每个节点的真分支是叶子节点，0 是内部节点。要表示一个只有一个节点的树（即叶子节点），可以通过一个 nodes_* 条目来实现，其中真分支和假分支都引用同一个 leaf_* 条目
nodes_truenodeids - INTS（必需）：

如果nodes_trueleafs在某个条目中为false，这表示真分支节点的位置。这个位置可以用来索引到nodes_*条目。如果nodes_trueleafs为false，则它是leaf_*属性的索引。
post_transform - INT (默认值为 '0'):

指示应用于分数的转换。
可选值为‘NONE’ (0)、‘SOFTMAX’ (1)、‘LOGISTIC’ (2)、‘SOFTMAX_ZERO’ (3) 或 ‘PROBIT’ (4)，默认为‘NONE’ (0)
tree_roots - INTS (必填) :

索引到 nodes_* 以获取每棵树的根节点。树结构源自每个节点的分支。

输入¶

X (异构) - T:

输入形状为 [批量大小, 特征数量]

输出¶

Y (异构) - T:

输出形状为 [批量大小, 目标数量]

类型约束¶

T 在 ( tensor(double), tensor(float), tensor(float16) ) 中:

输入类型必须是数值类型的张量。

示例¶

_tree_ensemble_single_tree¶

import numpy as np
import onnx

node = onnx.helper.make_node(
    "TreeEnsemble",
    ["X"],
    ["Y"],
    domain="ai.onnx.ml",
    n_targets=2,
    membership_values=None,
    nodes_missing_value_tracks_true=None,
    nodes_hitrates=None,
    aggregate_function=1,
    post_transform=0,
    tree_roots=[0],
    nodes_modes=make_tensor(
        "nodes_modes",
        onnx.TensorProto.UINT8,
        (3,),
        np.array([0, 0, 0], dtype=np.uint8),
    ),
    nodes_featureids=[0, 0, 0],
    nodes_splits=make_tensor(
        "nodes_splits",
        onnx.TensorProto.DOUBLE,
        (3,),
        np.array([3.14, 1.2, 4.2], dtype=np.float64),
    ),
    nodes_truenodeids=[1, 0, 1],
    nodes_trueleafs=[0, 1, 1],
    nodes_falsenodeids=[2, 2, 3],
    nodes_falseleafs=[0, 1, 1],
    leaf_targetids=[0, 1, 0, 1],
    leaf_weights=make_tensor(
        "leaf_weights",
        onnx.TensorProto.DOUBLE,
        (4,),
        np.array([5.23, 12.12, -12.23, 7.21], dtype=np.float64),
    ),
)

x = np.array([1.2, 3.4, -0.12, 1.66, 4.14, 1.77], np.float64).reshape(3, 2)
y = np.array([[5.23, 0], [5.23, 0], [0, 12.12]], dtype=np.float64)
expect(
    node,
    inputs=[x],
    outputs=[y],
    name="test_ai_onnx_ml_tree_ensemble_single_tree",
)

_tree_ensemble_set_membership¶

import numpy as np
import onnx

node = onnx.helper.make_node(
    "TreeEnsemble",
    ["X"],
    ["Y"],
    domain="ai.onnx.ml",
    n_targets=4,
    aggregate_function=1,
    membership_values=make_tensor(
        "membership_values",
        onnx.TensorProto.FLOAT,
        (8,),
        [1.2, 3.7, 8, 9, np.nan, 12, 7, np.nan],
    ),
    nodes_missing_value_tracks_true=None,
    nodes_hitrates=None,
    post_transform=0,
    tree_roots=[0],
    nodes_modes=make_tensor(
        "nodes_modes",
        onnx.TensorProto.UINT8,
        (3,),
        np.array([0, 6, 6], dtype=np.uint8),
    ),
    nodes_featureids=[0, 0, 0],
    nodes_splits=make_tensor(
        "nodes_splits",
        onnx.TensorProto.FLOAT,
        (3,),
        np.array([11, 232344.0, np.nan], dtype=np.float32),
    ),
    nodes_trueleafs=[0, 1, 1],
    nodes_truenodeids=[1, 0, 1],
    nodes_falseleafs=[1, 0, 1],
    nodes_falsenodeids=[2, 2, 3],
    leaf_targetids=[0, 1, 2, 3],
    leaf_weights=make_tensor(
        "leaf_weights", onnx.TensorProto.FLOAT, (4,), [1, 10, 1000, 100]
    ),
)

x = np.array([1.2, 3.4, -0.12, np.nan, 12, 7], np.float32).reshape(-1, 1)
expected = np.array(
    [
        [1, 0, 0, 0],
        [0, 0, 0, 100],
        [0, 0, 0, 100],
        [0, 0, 1000, 0],
        [0, 0, 1000, 0],
        [0, 10, 0, 0],
    ],
    dtype=np.float32,
)
expect(
    node,
    inputs=[x],
    outputs=[expected],
    name="test_ai_onnx_ml_tree_ensemble_set_membership",
)