配置管线

此功能处于 Alpha 阶段。有关功能阶段的更多信息，请参阅API 阶段。

本页解释了如何创建和配置节点回归管线。

创建管线

构建新管线的第一步是使用gds.alpha.pipeline.nodeRegression.create创建一个管线。这会将一个可训练的管线对象存储在类型为节点回归训练管线的管线目录中。它表示一个可配置的管线，以后可以调用其进行训练，而训练又会创建一个回归模型。后者是一个存储在目录中且类型为NodeRegression的模型。

语法

创建管线语法

CALL gds.alpha.pipeline.nodeRegression.create(
  pipelineName: String
) YIELD
  name: String,
  nodePropertySteps: List of Map,
  featureProperties: List of String,
  splitConfig: Map,
  autoTuningConfig: Map,
  parameterSpace: List of Map

表 1. 参数
名称	类型	描述
pipelineName	字符串	创建的管线的名称。

表 2. 结果
名称	类型	描述
名称	字符串	管线的名称。
nodePropertySteps	映射列表	节点属性步骤的配置列表。
featureProperties	字符串列表	用作特征的节点属性列表。
splitConfig	映射	定义模型训练前拆分的配置。
autoTuningConfig	映射	定义自动调优行为的配置。
parameterSpace	映射列表	模型参数配置列表，训练模式使用此列表进行模型选择。

示例

以下将创建一个管线

CALL gds.alpha.pipeline.nodeRegression.create('pipe')

表 3. 结果
名称	nodePropertySteps	featureProperties	splitConfig	autoTuningConfig	parameterSpace
"pipe"	[]	[]	{testFraction=0.3, validationFolds=3}	{maxTrials=10}	{LinearRegression=[], RandomForest=[]}

这表明新创建的管线尚未包含任何步骤，并且拆分和训练参数使用了默认值。

添加节点属性

节点回归管线可以在变异模式下执行一个或多个 GDS 算法，这些算法在内存图 (in-memory graph) 中创建节点属性。这些生成节点属性的步骤可以一个接一个地链接起来，并且创建的属性稍后可以作为特征使用。此外，添加到训练管线中的节点属性步骤在训练模型和回归管线应用于回归时都会执行。

要添加的过程名称可以是完全限定的 GDS 过程名称，以.mutate结尾。结尾的.mutate可以省略，也可以使用简写形式，例如node2vec而不是gds.node2vec.mutate。但请注意，层级限定符仍必须作为名称的一部分给出。

例如，预处理算法可以用作节点属性步骤。

语法

添加节点属性语法

CALL gds.alpha.pipeline.nodeRegression.addNodeProperty(
  pipelineName: String,
  procedureName: String,
  procedureConfiguration: Map
) YIELD
  name: String,
  nodePropertySteps: List of Map,
  featureProperties: List of String,
  splitConfig: Map,
  autoTuningConfig: Map,
  parameterSpace: List of Map

表 4. 参数
名称	类型	描述
pipelineName	字符串	管线的名称。
procedureName	字符串	要添加到管线的过程名称。
procedureConfiguration	映射	用于为节点属性过程生成配置的映射。它支持所有特定于过程的配置，但不包括参数`nodeLabels`和`relationshipTypes`。此外，它还支持下表中列出的上下文参数。

表 5. 节点属性步骤上下文配置
名称	类型	默认值	描述
contextNodeLabels	字符串列表	`[]`	作为上下文添加的附加节点标签。
contextRelationshipTypes	字符串列表	`[]`	作为上下文添加的附加关系类型。

在训练期间，上下文配置与训练配置结合，为每个节点属性步骤生成最终的节点标签和关系类型过滤器。

表 6. 结果
名称	类型	描述
名称	字符串	管线的名称。
nodePropertySteps	映射列表	节点属性步骤的配置列表。
featureProperties	字符串列表	用作特征的节点属性列表。
splitConfig	映射	定义模型训练前拆分的配置。
autoTuningConfig	映射	定义自动调优行为的配置。
parameterSpace	映射列表	模型参数配置列表，训练模式使用此列表进行模型选择。

示例

以下将向管线添加一个节点属性步骤。这里我们假设输入图包含属性sizePerStory。

CALL gds.alpha.pipeline.nodeRegression.addNodeProperty('pipe', 'scaleProperties', {
  nodeProperties: 'sizePerStory',
  scaler: 'MinMax',
  mutateProperty:'scaledSizes'
}) YIELD name, nodePropertySteps

表 7. 结果
名称	nodePropertySteps
"pipe"	[{config={contextNodeLabels=[], contextRelationshipTypes=[], mutateProperty="scaledSizes", nodeProperties="sizePerStory", scaler="MinMax"}, name="gds.scaleProperties.mutate"}]

scaledSizes属性稍后可以作为特征使用。

添加特征

节点回归管线允许您选择可用节点属性的子集作为机器学习模型的特征。执行管线时，所选的nodeProperties必须存在于输入图中，或由先前的节点属性步骤创建。

语法

向管线添加特征语法

CALL gds.alpha.pipeline.nodeRegression.selectFeatures(
  pipelineName: String,
  featureProperties: List or String
) YIELD
  name: String,
  nodePropertySteps: List of Map,
  featureProperties: List of String,
  splitConfig: Map,
  autoTuningConfig: Map,
  parameterSpace: List of Map

表 8. 参数
名称	类型	描述
pipelineName	字符串	管线的名称。
featureProperties	列表或字符串	用作模型特征的节点属性。

表 9. 结果
名称	类型	描述
名称	字符串	管线的名称。
nodePropertySteps	映射列表	节点属性步骤的配置列表。
featureProperties	字符串列表	用作特征的节点属性列表。
splitConfig	映射	定义模型训练前拆分的配置。
autoTuningConfig	映射	定义自动调优行为的配置。
parameterSpace	映射列表	模型参数配置列表，训练模式使用此列表进行模型选择。

示例

以下将为管线选择两个特征属性。

CALL gds.alpha.pipeline.nodeRegression.selectFeatures('pipe', ['scaledSizes', 'sizePerStory'])
YIELD name, featureProperties

表 10. 结果
名称	featureProperties
"pipe"	["scaledSizes", "sizePerStory"]

这里我们假设输入图包含属性sizePerStory，并且scaledSizes是在nodePropertyStep中创建的。

配置节点拆分

节点回归管线管理节点的拆分，将节点拆分为多个集合，这些集合用于训练、测试和验证参数空间中定义的模型候选。配置拆分是可选的，如果省略，将使用默认设置进行拆分。管线的拆分配置可以通过使用gds.model.list并生成splitConfig来检查。

节点拆分在训练过程中使用如下：

输入图被分成两部分：训练图和测试图。请参阅下面的示例。
训练图进一步划分为若干验证折叠，每个折叠由训练部分和验证部分组成。请参阅下面的动画。
每个模型候选都在每个训练部分上进行训练，并在各自的验证部分上进行评估。
根据主要指标，得分最高的模型将赢得训练。
获胜模型将在整个训练图上重新训练。
获胜模型在训练图和测试图上进行评估。
获胜模型在整个原始图上重新训练。

下面我们以一个包含 12 个节点的图为例。首先，我们使用 0.25 的holdoutFraction拆分为训练子图和测试子图。

然后我们执行三个验证折叠，首先将训练子图拆分为 3 个不相交的子集（s1、s2 和 s3），然后轮流使用哪个子集进行验证。对于每个折叠，所有候选模型都使用红色节点进行训练，并使用绿色节点进行验证。

语法

配置节点拆分语法

CALL gds.alpha.pipeline.nodeRegression.configureSplit(
  pipelineName: String,
  configuration: Map
) YIELD
  name: String,
  nodePropertySteps: List of Map,
  featureProperties: List of String,
  splitConfig: Map,
  autoTuningConfig: Map,
  parameterSpace: List of Map

表 11. 参数
名称	类型	描述
pipelineName	字符串	管线的名称。
配置	映射	图的拆分配置。

表 12. 配置
名称	类型	默认值	描述
validationFolds	整数	3	模型选择期间使用的训练图的划分数量。
testFraction	双精度浮点数	0.3	用于测试的图的比例。必须在 (0, 1) 范围内。用于训练的比例是`1 - testFraction`。

表 13. 结果
名称	类型	描述
名称	字符串	管线的名称。
nodePropertySteps	映射列表	节点属性步骤的配置列表。
featureProperties	字符串列表	用作特征的节点属性列表。
splitConfig	映射	定义模型训练前拆分的配置。
autoTuningConfig	映射	定义自动调优行为的配置。
parameterSpace	映射列表	模型参数配置列表，训练模式使用此列表进行模型选择。

示例

以下将为管线配置图的拆分

CALL gds.alpha.pipeline.nodeRegression.configureSplit('pipe', {
  testFraction: 0.2,
  validationFolds: 5
}) YIELD splitConfig

表 14. 结果
splitConfig
{testFraction=0.2, validationFolds=5}

我们现在重新配置了管线的图拆分，这将在训练期间使用。

添加模型候选

管线包含一个模型候选配置集合，该集合最初是空的。此集合称为参数空间。每个模型候选配置都包含训练参数的固定值或范围。当存在范围时，范围内的值由自动调优算法自动确定，请参阅自动调优。必须使用以下过程之一将一个或多个模型配置添加到训练管线的参数空间：

gds.alpha.pipeline.nodeRegression.addLinearRegression
gds.alpha.pipeline.nodeRegression.addRandomForest

有关 GDS 中可用训练方法的详细信息，请参阅训练方法。

在训练管线中，我们进一步解释了如何训练、评估和比较配置的模型候选。

管线的参数空间可以通过使用gds.model.list并生成parameterSpace来检查。

在训练管线之前，必须至少向管线添加一个模型候选。

语法

添加线性回归模型候选

CALL gds.alpha.pipeline.nodeRegression.addLinearRegression(
  pipelineName: String,
  configuration: Map
) YIELD
  name: String,
  nodePropertySteps: List of Map,
  featureProperties: List of String,
  splitConfig: Map,
  autoTuningConfig: Map,
  parameterSpace: Map

表 15. 参数
名称	类型	描述
pipelineName	字符串	管线的名称。
配置	映射	候选模型的线性回归配置。支持的模型候选参数在下一表中定义。

表 16. 线性回归配置
名称	类型	默认值	可选	描述
batchSize	整数或映射 ^[1]	`100`	是	每个批次的节点数。
minEpochs	整数或映射 ^[1]	`1`	是	最小训练迭代次数。
maxEpochs	整数或映射 ^[1]	`100`	是	最大训练迭代次数。
learningRate ^[2]	浮点数或映射 ^[1]	`0.001`	是	学习率决定了在每个迭代中，沿着 Adam 优化器指定的方向最小化损失时的步长。
patience	整数或映射 ^[1]	`1`	是	连续无成效迭代的最大次数。
tolerance ^[2]	浮点数或映射 ^[1]	`0.001`	是	损失被认为是有效改进的最小幅度。
penalty ^[2]	浮点数或映射 ^[1]	`0.0`	是	用于逻辑回归的惩罚项。默认情况下，不施加惩罚。
1. 映射应为`{range: [minValue, maxValue]}`的形式。它由自动调优使用。 2. 此参数的范围在对数尺度上进行自动调优。

表 17. 结果
名称	类型	描述
名称	字符串	管线的名称。
nodePropertySteps	映射列表	节点属性步骤的配置列表。
featureProperties	字符串列表	用作特征的节点属性列表。
splitConfig	映射	定义模型训练前拆分的配置。
autoTuningConfig	映射	定义自动调优行为的配置。
parameterSpace	映射列表	模型参数配置列表，训练模式使用此列表进行模型选择。

添加随机森林模型候选

CALL gds.alpha.pipeline.nodeRegression.addRandomForest(
  pipelineName: String,
  configuration: Map
) YIELD
  name: String,
  nodePropertySteps: List of Map,
  featureProperties: List of String,
  splitConfig: Map,
  autoTuningConfig: Map,
  parameterSpace: Map

表 18. 参数
名称	类型	描述
pipelineName	字符串	管线的名称。
配置	映射	候选模型的随机森林配置。支持的模型候选参数在下一表中定义。

表 19. 随机森林回归配置
名称	类型	默认值	可选	描述
maxFeaturesRatio	浮点数或映射 ^[3]	`1 / sqrt(\|features\|)`	是	查找最佳拆分时要考虑的特征比例
numberOfSamplesRatio	浮点数或映射 ^[3]	`1.0`	是	每个决策树要考虑的样本比例。我们使用带替换的采样。值为`0`表示使用每个训练样本（不采样）。
numberOfDecisionTrees	整数或映射 ^[3]	`100`	是	决策树的数量。
maxDepth	整数或映射 ^[3]	`无最大深度`	是	决策树的最大深度。
minLeafSize	整数或映射 ^[3]	`1`	是	决策树中叶节点的最小样本数。必须严格小于`minSplitSize`。
minSplitSize	整数或映射 ^[3]	`2`	是	决策树中拆分内部节点所需的最小样本数。必须严格大于`minLeafSize`。
3. 映射应为`{range: [minValue, maxValue]}`的形式。它由自动调优使用。

表 20. 结果
名称	类型	描述
名称	字符串	管线的名称。
nodePropertySteps	映射列表	节点属性步骤的配置列表。
featureProperties	字符串列表	用作特征的节点属性列表。
splitConfig	映射	定义模型训练前拆分的配置。
autoTuningConfig	映射	定义自动调优行为的配置。
parameterSpace	映射列表	模型参数配置列表，训练模式使用此列表进行模型选择。

示例

我们可以向管线添加多个模型候选。

以下将添加一个带默认配置的线性回归模型候选

CALL gds.alpha.pipeline.nodeRegression.addLinearRegression('pipe')
YIELD parameterSpace

以下将添加一个随机森林模型候选

CALL gds.alpha.pipeline.nodeRegression.addRandomForest('pipe', {numberOfDecisionTrees: 5})
YIELD parameterSpace

以下将添加一个带有范围参数的线性回归模型候选

CALL gds.alpha.pipeline.nodeRegression.addLinearRegression('pipe', {maxEpochs: 500, penalty: {range: [1e-4, 1e2]}})
YIELD parameterSpace
RETURN parameterSpace.RandomForest AS randomForestSpace, parameterSpace.LinearRegression AS linearRegressionSpace

表 21. 结果
randomForestSpace	linearRegressionSpace
[{maxDepth=2147483647, methodName="RandomForest", minLeafSize=1, minSplitSize=2, numberOfDecisionTrees=5, numberOfSamplesRatio=1.0}]	[{batchSize=100, learningRate=0.001, maxEpochs=100, methodName="LinearRegression", minEpochs=1, patience=1, penalty=0.0, tolerance=0.001}, {batchSize=100, learningRate=0.001, maxEpochs=500, methodName="LinearRegression", minEpochs=1, patience=1, penalty={range=[0.0001, 100.0]}, tolerance=0.001}]

管线中的parameterSpace现在包含三个不同的模型候选，并扩展了默认值。在训练期间的模型选择过程中，将尝试每个指定的模型候选。

这些是关于如何添加和配置模型候选的一些简单示例。有关如何调整每种方法的配置参数的更多信息，请参阅训练方法。

配置自动调优

为了找到好的模型，管线支持自动调优训练算法的参数。可选地，可以使用下面描述的过程来配置自动调优行为。否则，将使用默认的自动调优配置。目前，只能配置要评估的超参数设置的最大尝试次数。

语法

配置自动调优语法

CALL gds.alpha.pipeline.nodeRegression.configureAutoTuning(
  pipelineName: String,
  configuration: Map
) YIELD
  name: String,
  nodePropertySteps: List of Map,
  featureProperties: List of String,
  splitConfig: Map,
  autoTuningConfig: Map,
  parameterSpace: List of Map

表 22. 参数
名称	类型	描述
pipelineName	字符串	创建的管线的名称。
配置	映射	自动调优的配置。

表 23. 配置
名称	类型	默认值	描述
maxTrials	整数	10	`maxTrials`的值决定了训练管线时应评估和比较的最大允许模型候选数。如果参数空间中不存在范围，则忽略`maxTrials`并评估参数空间中的每个模型候选。

表 24. 结果
名称	类型	描述
名称	字符串	管线的名称。
nodePropertySteps	映射列表	节点属性步骤的配置列表。
featureProperties	字符串列表	用作特征的节点属性列表。
splitConfig	映射	定义模型训练前拆分的配置。
autoTuningConfig	映射	定义自动调优行为的配置。
parameterSpace	映射列表	模型参数配置列表，训练模式使用此列表进行模型选择。

示例

以下将配置自动调优的最大尝试次数

CALL gds.alpha.pipeline.nodeRegression.configureAutoTuning('pipe', {
  maxTrials: 100
}) YIELD autoTuningConfig

表 25. 结果
autoTuningConfig
{maxTrials=100}

我们明确配置了自动调优，使其在训练期间最多尝试 100 个模型候选。