列出模型

可以使用 gds.model.list() 过程检索目录中模型的相关信息。

语法

从目录中列出模型

CALL gds.model.list(modelName: String)
YIELD
    modelName: String,
    modelType: String,
    modelInfo: Map,
    creationTime: DateTime,
    trainConfig: Map,
    graphSchema: Map,
    loaded: Boolean,
    stored: Boolean,
    published: Boolean

表 1. 参数
名称	类型	默认	可选	描述
modelName	字符串	`不适用`	是	模型的名称。如果未指定，将列出目录中的所有模型。

表 2. 结果
名称	类型	描述
modelName	字符串	模型名称。
modelType	字符串	模型类型。指示用于训练该模型的训练算法。
modelInfo	Map	关于已训练模型的详细类型特定信息。
creationTime	Datetime	模型创建的时间。
trainConfig	Map	用于训练模型的训练配置。
graphSchema	Map	模型训练所基于的图模式 (Schema)。
loaded	布尔值	如果模型已加载到内存模型目录中，则为 True。
stored	布尔值	如果模型已存储在磁盘上，则为 True。
published	布尔值	如果模型已发布，则为 True。

示例

在本节中，我们将演示如何列出模型目录中的模型。为简单起见，我们假设名为 my-model1 和 my-model2 的两个模型已经过训练并存在于模型目录中。

列出所有模型

最简单的情况是列出所有模型。这可以通过在调用 gds.model.list() 时不带任何参数来实现。

列出所有模型的信息

CALL gds.model.list()
YIELD modelName, modelType, modelInfo, loaded, stored, published

表 3. 结果
modelName	modelType	modelInfo	loaded	stored	published
`"my-model1"`	`"example-model-type"`	`{exampleModelInfo="exampleValue"}`	`true`	`false`	`false`
`"my-model2"`	`"example-model-type"`	`{number=42}`	`true`	`false`	`false`

由于此模型仅为一个示例，我们省略了其训练详情。

列出特定模型

我们还可以请求仅列出关于某个特定模型的详细信息。这可以通过将模型名称作为参数提供给该过程来实现。

列出特定模型的信息

CALL gds.model.list('my-model1')
YIELD modelName, modelType, modelInfo, loaded, stored, published

表 4. 结果
modelName	modelType	modelInfo	loaded	stored	published
`"my-model1"`	`"example-model-type"`	`{exampleModelInfo="exampleValue"}`	`true`	`false`	`false`