Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update algorithm pages #1020

Merged
merged 3 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions pages/advanced-algorithms/available-algorithms/algo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ filters.

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

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

- `nodes: List[Node]` ➡ A list of all the input nodes.

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

{<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.
- `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.
If subgraph is not specified, the algorithm is computed on the entire graph by default.
- `start: Node` ➡ The starting node.
- `target: Node` ➡ The target node.
- `config: Map` ➡ The configuration map.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ The procedure returns the betweenness centrality values.

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

- `directed: boolean (default=True)` ➡ If `False` the direction of the relationships is ignored.
- `normalized: boolean (default=True)` ➡ If `True` the betweenness values are normalized by
`2/((n-1)(n-2))` for graphs, and `1/((n-1)(n-2))` for directed graphs where
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ The procedure finds biconnected components.
{<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.
- `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.
If subgraph is not specified, the algorithm is computed on the entire graph by default.



{<h4> Output: </h4>}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ relationship connects nodes between these sets.

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


{<h4> Output: </h4>}

Expand Down
4 changes: 3 additions & 1 deletion pages/advanced-algorithms/available-algorithms/bridges.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ creates two disjoint graph components.

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


{<h4> Output: </h4>}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,12 @@ Computes graph communities using the Louvain method.

{<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,
the algorithm uses the `weight` relationship attribute when present and otherwise
treats the graph as unweighted.
- `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.
If subgraph is not specified, the algorithm is computed on the entire graph by default.

- `weight: string (default=null)` ➡ Specifies the name of the property containing the edge weight. Users can set their own weight property;
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`.
To utilize a custom weight property, the user must set the `--storage-properties-on-edges=true` flag.
- `coloring: boolean (default=False)` ➡ If set, use the graph coloring heuristic for effective parallelization.
- `min_graph_shrink: integer (default=100000)` ➡ The graph coarsening optimization stops upon shrinking the graph to this many nodes.
- `community_alg_threshold: double (default=0.000001)` ➡ Controls how long the algorithm iterates. When the gain in modularity
Expand All @@ -72,7 +74,7 @@ Computes graph communities using the Louvain method.

{<h4> Output: </h4>}

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

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

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

- `subgraph_nodes: List[Node]` ➡ List of nodes in the subgraph.
- `subgraph_relationships: List[Relationship]` ➡ List of relationships in the subgraph.
- `weight: str (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.
- `weight: string (default=null)` ➡ Specifies the name of the property containing the edge weight. Users can set their own weight property;
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`.
To utilize a custom weight property, the user must set the `--storage-properties-on-edges=true` flag.
- `coloring: bool (default=False)` ➡ If set, use the graph coloring heuristic for effective parallelization.
- `min_graph_shrink: int (default=100000)` ➡ The graph coarsening optimization stops upon shrinking the graph to this many nodes.
- `community_alg_threshold: double (default=0.000001)` ➡ Controls how long the algorithm iterates. When the gain in modularity
Expand All @@ -108,7 +112,7 @@ Computes graph communities over a subgraph using the Louvain method.

{<h4> Output: </h4>}

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

{<h4> Usage: </h4>}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ the user should check if that is indeed the case.

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

- `directed: boolean (default=False)` ➡ Specifies whether the graph is directed. If not set,
the graph is treated as undirected.
- `weighted: boolean (default=False)` ➡ Specifies whether the graph is weighted. If not set,
Expand All @@ -88,7 +90,7 @@ the user should check if that is indeed the case.

{<h4> Output: </h4>}

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

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

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


{<h4> Output: </h4>}

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

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

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

- `createdVertices: mgp.List[mgp.Vertex]` ➡ Nodes created in the latest graph
update.
- `createdEdges: mgp.List[mgp.Edge]` ➡ Relationships created in the latest graph update.
Expand All @@ -144,7 +150,7 @@ changes applied in the latest graph update and returns the results.

{<h4> Output: </h4>}

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

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

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


{<h4> Output: </h4>}

Expand Down
Loading