Commands graph/annotate_weighted_degrees¶
Calculates the weighted degree of each vertex with respect to an (optional) set of labels.
POST /v1/commands/¶
GET /v1/commands/:id¶
Request¶
Route
POST /v1/commands/
Body
| name: | graph/annotate_weighted_degrees |
|---|---|
| arguments: | graph : Graph
output_property_name : unicode
degree_option : unicode (default=None)
input_edge_labels : list (default=None)
edge_weight_property : unicode (default=None)
edge_weight_default : float64 (default=None)
|
Headers
Authorization: test_api_key_1
Content-type: application/json
Description
Pulls graph from underlying store, calculates weighted degrees and writes them into the property specified, and then writes the output graph to the underlying store.
Degree Calculation
A fundamental quantity in graph analysis is the degree of a vertex: The degree of a vertex is the number of edges adjacent to it.
For a directed edge relation, a vertex has both an out-degree (the number of edges leaving the vertex) and an in-degree (the number of edges entering the vertex).
The toolkit provides a routine annotate_degrees
for calculating the degrees of vertices.
The Trusted Analytics Platform routine annotate_degrees can be executed at distributed scale.
In the presence of edge weights, vertices can have weighted degrees: The weighted degree of a vertex is the sum of weights of edges adjacent to it. Analogously, the weighted in-degree of a vertex is the sum of the weights of the edges entering it, and the weighted out-degree is the sum of the weights of the edges leaving the vertex.
The toolkit provides this routine for the distributed calculation of weighted vertex degrees.
Response¶
Status
200 OK
Body
Returns information about the command. See the Response Body for Get Command here below. It is the same.