文档首页> 图引擎服务 GES> API参考> 业务面API> 持久化版> HyG算法API> 算法API参数参考> Bigclam算法（bigclam）
更新时间：2024-05-23 GMT+08:00
查看PDF

Bigclam算法（bigclam）

功能介绍

根据输入参数，执行BigClam算法。

BigClam算法是一种重叠社区发现算法，该算法将节点与社区之间的关系建模为一个二部图，假设图中节点的连边是根据社区关系生成的，其可以检测出图中的重叠社区。

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

项目ID。获取方法请参见获取项目ID。

graph_name

是

String

图名称。

请求参数

表2 请求Body参数

参数

是否必选

类型

说明

algorithmName

是

String

算法名字。

parameters

是

parameters Object

算法参数。
表3 parameters

参数

是否必选

类型

说明

convergence

否

Double

收敛精度，取值范围为(0,1)，默认值为0.00001。

max_iterations

否

Integer

最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为100。

community_num_space

是

String

社区数量搜索空间，多个整形值用","隔开，最多不超过100个，每个整形值的范围为[1,10000]。

learning_rate

否

Double

模型学习率，取值大于0，默认为0.01。

响应参数

参数

类型

说明

errorMessage

String

系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。

errorCode

String

系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。

jobId

String

执行算法任务ID。请求失败时，字段为空。

说明：

可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。

jobType

Integer

任务类型。请求失败时，字段为空。

请求示例

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm   
{
 "algorithmName":"bigclam",
 "parameters":{
        "community_num_space":"3,2,10"
 }
}

SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例

状态码： 200

成功响应示例

Http Status Code: 200
{  
"jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122",
"jobType": 1
}

状态码： 400

失败响应示例

Http Status Code: 400
{
"errorMessage":"graph [demo] is not found",
"errorCode":"GES.8402"
}

查询结果

  • 请求示例
    GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{jobId}/status?limit=limit
  • 查询结果响应
    表4 reponse_data参数说明

    参数

    类型

    说明

    community_num

    Integer

    社团数量

    communities

    List

    各节点对应的社团，格式：

    [{vertexId1:communityIds},{vertexId2:communityIds}],

    其中,

    vertexId：string类型

    communityIds：list类型，每个元素为int类型。

    log_likelihood

    Double

    当前图生成模型计算出的模型节点之间连边的联合概率的log值，该值越大表示估计的社区数量越精准。

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。

父主题： 算法API参数参考