Skip to content

Commit 3b660c1

Browse files
authored
Add Memgraph 2.21.0 and MAGE 1.21.0 docs pages (#1009)
1 parent 9de0b44 commit 3b660c1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1416
-286
lines changed

pages/advanced-algorithms/available-algorithms.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ library](/advanced-algorithms/install-mage).
2424

2525
| Algorithms | Lang | Description |
2626
|------------------------------------------------------------------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
27-
| [algo](/advanced-algorithms/available-algorithms/algo) | C++ | The algo module provides users with a powerful set of graph algorithms, enabling users to perform complex graph-based operations and computations, such as graph traversal, edge detection, and more. |
27+
| [algo](/advanced-algorithms/available-algorithms/algo) | C++ | The algo module provides users with a powerful set of graph algorithms, enabling users to perform complex graph-based operations and computations, such as graph traversal, edge detection, and more. |
2828
| [betweenness_centrality](/advanced-algorithms/available-algorithms/betweenness_centrality) | C++ | The betweenness centrality of a node is defined as the sum of the of all-pairs shortest paths that run through the node, divided by the number of all-pairs shortest paths in the graph. The algorithm has O(nm) time complexity. |
2929
| [biconnected_components](/advanced-algorithms/available-algorithms/biconnected_components) | C++ | Algorithm for calculating maximal biconnected subgraph. A biconnected subgraph is a subgraph with a property that if any vertex were to be removed, the graph will remain connected. |
3030
| [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. |
@@ -36,6 +36,7 @@ library](/advanced-algorithms/install-mage).
3636
| [graph_coloring](/advanced-algorithms/available-algorithms/graph_coloring) | Python | Algorithm for assigning labels to the graph elements subject to certain constraints. In this form, it is a way of coloring the graph vertices such that no two adjacent vertices are of the same color. |
3737
| [katz_centrality](/advanced-algorithms/available-algorithms/katz_centrality) | C++ | Katz centrality is a centrality measurement that outputs a node's influence based on the number of shortest paths and their weighted length. |
3838
| [kmeans_clustering](/advanced-algorithms/available-algorithms/kmeans_clustering) | Python | An algorithm for clustering given data. |
39+
| [leiden_community_detection](/advanced-algorithms/available-algorithms/leiden_community_detection) | C++ | The Leiden method for community detection is an improvement over the Louvain method, designed to find communities with maximum modularity in a graph while addressing issues of disconnected communities. Runs in _O_(L\*E) time and _O_(V\*E) space, where *L* is the number of iterations of the algorithm, E is the number of edges, V is the number of nodes. |
3940
| [max_flow](/advanced-algorithms/available-algorithms/max_flow) | Python | An algorithm for finding a flow through a graph such that it is the maximum possible flow. |
4041
| [node_similarity](/advanced-algorithms/available-algorithms/node_similarity) | C++ | A module that contains similarity measures for calculating the similarity between two nodes. |
4142
| [pagerank](/advanced-algorithms/available-algorithms/pagerank) | C++ | Algorithm that yields the influence measurement based on the recursive information about the connected nodes influence. |

pages/advanced-algorithms/available-algorithms/algo.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ filters.
4242

4343
{<h4> Input: </h4>}
4444

45-
- `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.
45+
- `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.
46+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
4647
- `start_node: Node` ➡ The first node of the returned path.
4748
- `end_node: Node` ➡ The final node of the returned path.
4849
- `relationship_types: List[String]` ➡ A list of relationship filters, explained below.
@@ -103,7 +104,9 @@ including any self-referencing relationships.
103104

104105
{<h4> Input: </h4>}
105106

106-
- `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.
107+
- `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.
108+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
109+
107110
- `nodes: List[Node]` ➡ A list of all the input nodes.
108111

109112
{<h4> Output: </h4>}
@@ -146,7 +149,8 @@ In case you don't want to use geospatial types, or you want a custom heuristic,
146149

147150
{<h4> Input: </h4>}
148151

149-
- `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.
152+
- `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.
153+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
150154
- `start: Node` ➡ The starting node.
151155
- `target: Node` ➡ The target node.
152156
- `config: Map` ➡ The configuration map.

pages/advanced-algorithms/available-algorithms/betweenness_centrality.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@ The procedure returns the betweenness centrality values.
5252

5353
{<h4> Input: </h4>}
5454

55-
- `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.
55+
- `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.
56+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
57+
5658
- `directed: boolean (default=True)` ➡ If `False` the direction of the relationships is ignored.
5759
- `normalized: boolean (default=True)` ➡ If `True` the betweenness values are normalized by
5860
`2/((n-1)(n-2))` for graphs, and `1/((n-1)(n-2))` for directed graphs where

pages/advanced-algorithms/available-algorithms/biconnected_components.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ The procedure finds biconnected components.
4646
{<h4> Input: </h4>}
4747

4848

49-
- `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.
49+
- `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.
50+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
51+
5052

5153

5254
{<h4> Output: </h4>}

pages/advanced-algorithms/available-algorithms/bipartite_matching.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ relationship connects nodes between these sets.
4848

4949
{<h4> Input: </h4>}
5050

51-
- `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.
51+
- `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.
52+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
53+
5254

5355
{<h4> Output: </h4>}
5456

pages/advanced-algorithms/available-algorithms/bridges.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ creates two disjoint graph components.
4545

4646
{<h4> Input: </h4>}
4747

48-
- `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.
48+
- `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.
49+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
50+
4951

5052
{<h4> Output: </h4>}
5153

pages/advanced-algorithms/available-algorithms/community_detection.mdx

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,12 @@ Computes graph communities using the Louvain method.
5656

5757
{<h4> Input: </h4>}
5858

59-
- `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.
60-
- `weight: string (default=null)` ➡ Specifies the default relationship weight. If not set,
61-
the algorithm uses the `weight` relationship attribute when present and otherwise
62-
treats the graph as unweighted.
59+
- `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.
60+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
61+
62+
- `weight: string (default=null)` ➡ Specifies the name of the property containing the edge weight. Users can set their own weight property;
63+
if this property is not specified, the algorithm uses the `weight` edge attribute by default. If neither is set, each edge's weight defaults to `1`.
64+
To utilize a custom weight property, the user must set the `--storage-properties-on-edges=true` flag.
6365
- `coloring: boolean (default=False)` ➡ If set, use the graph coloring heuristic for effective parallelization.
6466
- `min_graph_shrink: integer (default=100000)` ➡ The graph coarsening optimization stops upon shrinking the graph to this many nodes.
6567
- `community_alg_threshold: double (default=0.000001)` ➡ Controls how long the algorithm iterates. When the gain in modularity
@@ -72,7 +74,7 @@ Computes graph communities using the Louvain method.
7274

7375
{<h4> Output: </h4>}
7476

75-
- `node: Vertex`Graph node.
77+
- `node: Vertex`A graph node for which the algorithm was performed and returned as part of the results.
7678
- `community_id: integer` ➡ Community ID. Defaults to $-1$ if the node does not belong to any community.
7779

7880
{<h4> Usage: </h4>}
@@ -90,12 +92,14 @@ Computes graph communities over a subgraph using the Louvain method.
9092

9193
{<h4> Input: </h4>}
9294

93-
- `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.
95+
- `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.
96+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
97+
9498
- `subgraph_nodes: List[Node]` ➡ List of nodes in the subgraph.
9599
- `subgraph_relationships: List[Relationship]` ➡ List of relationships in the subgraph.
96-
- `weight: str (default=null)` ➡ Specifies the default relationship weight. If not set,
97-
the algorithm uses the `weight` relationship attribute when present and otherwise
98-
treats the graph as unweighted.
100+
- `weight: string (default=null)` ➡ Specifies the name of the property containing the edge weight. Users can set their own weight property;
101+
if this property is not specified, the algorithm uses the `weight` edge attribute by default. If neither is set, each edge's weight defaults to `1`.
102+
To utilize a custom weight property, the user must set the `--storage-properties-on-edges=true` flag.
99103
- `coloring: bool (default=False)` ➡ If set, use the graph coloring heuristic for effective parallelization.
100104
- `min_graph_shrink: int (default=100000)` ➡ The graph coarsening optimization stops upon shrinking the graph to this many nodes.
101105
- `community_alg_threshold: double (default=0.000001)` ➡ Controls how long the algorithm iterates. When the gain in modularity
@@ -108,7 +112,7 @@ Computes graph communities over a subgraph using the Louvain method.
108112

109113
{<h4> Output: </h4>}
110114

111-
- `node: Vertex`Graph node.
115+
- `node: Vertex`A graph node for which the algorithm was performed and returned as part of the results.
112116
- `community_id: int` ➡ Community ID. Defaults to $-1$ if the node does not belong to any community.
113117

114118
{<h4> Usage: </h4>}

pages/advanced-algorithms/available-algorithms/community_detection_online.mdx

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ the user should check if that is indeed the case.
6565

6666
{<h4> Input: </h4>}
6767

68-
- `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.
68+
- `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.
69+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
70+
6971
- `directed: boolean (default=False)` ➡ Specifies whether the graph is directed. If not set,
7072
the graph is treated as undirected.
7173
- `weighted: boolean (default=False)` ➡ Specifies whether the graph is weighted. If not set,
@@ -88,7 +90,7 @@ the user should check if that is indeed the case.
8890

8991
{<h4> Output: </h4>}
9092

91-
- `node: Vertex`Graph node.
93+
- `node: Vertex`A graph node for which the algorithm was performed and returned as part of the results.
9294
- `community_id: integer` ➡ Community ID. If the node is not associated with any
9395
community, defaults to $-1$.
9496

@@ -108,11 +110,13 @@ are none, defaults to calling `set()` with default parameters.
108110

109111
{<h4> Input: </h4>}
110112

111-
- `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.
113+
- `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.
114+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
115+
112116

113117
{<h4> Output: </h4>}
114118

115-
- `node: Vertex`Graph node.
119+
- `node: Vertex`A graph node for which the algorithm was performed and returned as part of the results.
116120
- `community_id: integer` ➡ Community ID. Defaults to $-1$ if the node does not belong to any community.
117121

118122
{<h4> Usage: </h4>}
@@ -131,7 +135,9 @@ changes applied in the latest graph update and returns the results.
131135

132136
{<h4> Input: </h4>}
133137

134-
- `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.
138+
- `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.
139+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
140+
135141
- `createdVertices: mgp.List[mgp.Vertex]` ➡ Nodes created in the latest graph
136142
update.
137143
- `createdEdges: mgp.List[mgp.Edge]` ➡ Relationships created in the latest graph update.
@@ -144,7 +150,7 @@ changes applied in the latest graph update and returns the results.
144150

145151
{<h4> Output: </h4>}
146152

147-
- `node: Vertex`Graph node.
153+
- `node: Vertex`A graph node for which the algorithm was performed and returned as part of the results.
148154
- `community_id: integer` ➡ Community ID. If the node is not associated with any
149155
community, defaults to $-1$.
150156

@@ -182,7 +188,9 @@ Resets the algorithm to its initial state.
182188

183189
{<h4> Input: </h4>}
184190

185-
- `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.
191+
- `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.
192+
If subgraph is not specified, the algorithm is computed on the entire graph by default.
193+
186194

187195
{<h4> Output: </h4>}
188196

0 commit comments

Comments
 (0)