Add Leiden community detection algorithm docs #1014
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
14 tasks
| @@ -30,6 +30,7 @@ library](/advanced-algorithms/install-mage). | |||
| | [bipartite_matching](/advanced-algorithms/available-algorithms/bipartite_matching) | C++ | Algorithm for calculating maximum bipartite matching, where matching is a set of nodes chosen in such a way that no two edges share an endpoint. | | |||
| | [bridges](/advanced-algorithms/available-algorithms/bridges) | C++ | A bridge is an edge, which when deleted, increases the number of connected components. The goal of this algorithm is to detect edges that are bridges in a graph. | | |||
| | [community_detection](/advanced-algorithms/available-algorithms/community_detection) | C++ | The Louvain method for community detection is a greedy method for finding communities with maximum modularity in a graph. Runs in _O_(*n*log*n*) time. | | |||
| | [leiden_community_detection](/advanced-algorithms/available-algorithms/leiden_community_detection) | C++ | The Leiden method for community detection is an improvement on the Louvain method, designed to find communities with maximum modularity in a graph while addressing issues of disconnected communities. Runs in _O_(*L* *m*) time, where *L* is the number of iterations of the algorithm | |||
There was a problem hiding this comment.
Not in alphabetical order
| {<h4> Input: </h4>} | ||
|
|
||
| - `subgraph: Graph` (**OPTIONAL**) ➡ A specific subgraph, which is an [object of type Graph](/advanced-algorithms/run-algorithms#run-procedures-on-subgraph) returned by the `project()` function, on which the algorithm is run. | ||
| - `weight: string (default=null)` ➡ Specifies the default relationship weight. If not set, |
There was a problem hiding this comment.
Why is this a string and not a float? Does it refer to a property name?
|
|
||
| - `subgraph: Graph` (**OPTIONAL**) ➡ A specific subgraph, which is an [object of type Graph](/advanced-algorithms/run-algorithms#run-procedures-on-subgraph) returned by the `project()` function, on which the algorithm is run. | ||
| - `weight: string (default=null)` ➡ Specifies the default relationship weight. If not set, | ||
| the algorithm uses the `weight` relationship attribute when present and otherwise |
There was a problem hiding this comment.
Relationship implies "edge". Is that what you meant?
| - `weight: string (default=null)` ➡ Specifies the default relationship weight. If not set, | ||
| the algorithm uses the `weight` relationship attribute when present and otherwise | ||
| treats the graph as unweighted. | ||
| - `gamma: double (default=1.0)` ➡ Resolution parameter used when computing the modularity. Internally the value is divided by the number of relationships for an unweighted graph, or the sum of weights of all relationships otherwise. |
There was a problem hiding this comment.
Why is gamma divided by some kind of weight? Please explain.
|
|
||
| {<h4> Output: </h4>} | ||
|
|
||
| - `node: Vertex` ➡ Graph node. |
There was a problem hiding this comment.
Can we give this a more descriptive label? What is special about this single node that is returned? Is it some kind of centroid for the community?
|
|
||
| {<h4> Input: </h4>} | ||
|
|
||
| - `subgraph: Graph` (**OPTIONAL**) ➡ A specific subgraph, which is an [object of type Graph](/advanced-algorithms/run-algorithms#run-procedures-on-subgraph) returned by the `project()` function, on which the algorithm is run. |
There was a problem hiding this comment.
How does the algorithm behave when subgraph is NOT provided?
|
|
||
| - `node: Vertex` ➡ Graph node. | ||
| - `community_id: integer` ➡ Community ID. Defaults to $-1$ if the node does not belong to any community. | ||
| - `communities: list` ➡ List of intermediate communities that a node has been part of across iterations. |
There was a problem hiding this comment.
Does this indicate the community hierarchy?
|
|
||
| ### `get_subgraph()` | ||
|
|
||
| Computes graph communities over a subgraph using the Louvain method. |
There was a problem hiding this comment.
Why is Louvain on the Leiden page? I'm confused.
| ```cypher | ||
| CALL leiden_community_detection.get() | ||
| YIELD node, community_id, communities | ||
| RETURN node.id AS node_id, community_id, communities |
There was a problem hiding this comment.
It would be great to see an example where a node is a member of more than one hierarchical community
| - `subgraph: Graph` (**OPTIONAL**) ➡ A specific subgraph, which is an [object of type Graph](/advanced-algorithms/run-algorithms#run-procedures-on-subgraph) returned by the `project()` function, on which the algorithm is run. | ||
| - `subgraph_nodes: List[Node]` ➡ List of nodes in the subgraph. | ||
| - `subgraph_relationships: List[Relationship]` ➡ List of relationships in the subgraph. | ||
| - `weight: string (default=null)` ➡ Specifies the default relationship weight. If not set, |
There was a problem hiding this comment.
Does leiden require the --storage-properties-on-edges=true configuration?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add Leiden community detection algorithm docs to the available Mage algorithms.
Pull request type
Please check what kind of PR this is:
Related PRs and issues
PR this doc page is related to:
memgraph/mage#508
Checklist: