ai.onnx.ml - TreeEnsemble¶
TreeEnsemble - 5 (ai.onnx.ml)¶
版本¶
域:
ai.onnx.ml
since_version:
5
函数:
False
支持级别:
SupportType.COMMON
形状推断:
True
此版本的算子自 ai.onnx.ml 域的版本 5 起可用。
摘要¶
Tree Ensemble 算子。返回批处理中每个输入的回归值。输入的维度为 [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 - TENSOR (必需)
每个叶子的权重。
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)。此属性可能未定义,所有节点的默认值为 false (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",
)