Skip to content

Commit 8da411a

Browse files
committed
Add new algos
1 parent 672766c commit 8da411a

File tree

3 files changed

+52
-2
lines changed

3 files changed

+52
-2
lines changed

doc/sphinx/algorithms-conf.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,12 @@
9292
],
9393
"page_path": "algorithms/article-rank/"
9494
},
95+
{
96+
"name": "Articulation Points",
97+
"procedure": "gds.articulationPoints",
98+
"config": [],
99+
"page_path": "algorithms/articulation-points/"
100+
},
95101
{
96102
"name": "Betweenness Centrality",
97103
"procedure": "gds.betweenness",
@@ -120,6 +126,12 @@
120126
],
121127
"page_path": "algorithms/betweenness-centrality/"
122128
},
129+
{
130+
"name": "Bridges",
131+
"procedure": "gds.bridges",
132+
"config": [],
133+
"page_path": "algorithms/bridges/"
134+
},
123135
{
124136
"name": "CELF",
125137
"procedure": "gds.influenceMaximization.celf",

doc/sphinx/create_algorithms_rst.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33

44
INCLUDED_ALGORITHMS = {
55
"Article Rank",
6+
"Articulation Points",
67
"Betweenness Centrality",
8+
"Bridges",
79
# "CELF",
810
# "Closeness Centrality",
911
"Degree Centrality",

doc/sphinx/source/algorithms.rst

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -458,10 +458,28 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
458458
459459
Returns an estimation of the memory consumption for that procedure.
460460

461-
.. py:function:: gds.articulationPoints.stream(G: Graph, **config: Any) -> Series[Any]
461+
.. py:function:: gds.articulationPoints.stream(G: Graph, *, nodeLabels=['*'], relationshipTypes=['*'], concurrency=4, jobId=None, logProgress=True) -> Series[Any]
462462
463463
Articulation Points is an algorithm that finds nodes that disconnect components if removed.
464464

465+
|
466+
467+
**Parameters:**
468+
469+
* **G** - Graph
470+
471+
* **nodeLabels** - *(Optional)* Filter the named graph using the given node labels. Nodes with any of the given labels will be included. *Default*: ['*'].
472+
473+
* **relationshipTypes** - *(Optional)* Filter the named graph using the given relationship types. Relationships with any of the given types will be included. *Default*: ['*'].
474+
475+
* **concurrency** - *(Optional)* The number of concurrent threads used for running the algorithm. *Default*: 4.
476+
477+
* **jobId** - *(Optional)* An ID that can be provided to more easily track the algorithm’s progress. *Default*: None (Generated internally).
478+
479+
* **logProgress** - *(Optional)* If disabled the progress percentage will not be logged. *Default*: True.
480+
481+
482+
465483
.. py:function:: gds.articulationPoints.stream.estimate(G: Graph, **config: Any) -> Series[Any]
466484
467485
Returns an estimation of the memory consumption for that procedure.
@@ -946,10 +964,28 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
946964
BFS is a traversal algorithm, which explores all of the neighbor nodes at the present depth
947965
prior to moving on to the nodes at the next depth level.
948966

949-
.. py:function:: gds.bridges.stream(G: Graph, **config: Any) -> Series[Any]
967+
.. py:function:: gds.bridges.stream(G: Graph, *, nodeLabels=['*'], relationshipTypes=['*'], concurrency=4, jobId=None, logProgress=True) -> Series[Any]
950968
951969
An algorithm to find Bridge edges in a graph.
952970

971+
|
972+
973+
**Parameters:**
974+
975+
* **G** - Graph
976+
977+
* **nodeLabels** - *(Optional)* Filter the named graph using the given node labels. Nodes with any of the given labels will be included. *Default*: ['*'].
978+
979+
* **relationshipTypes** - *(Optional)* Filter the named graph using the given relationship types. Relationships with any of the given types will be included. *Default*: ['*'].
980+
981+
* **concurrency** - *(Optional)* The number of concurrent threads used for running the algorithm. *Default*: 4.
982+
983+
* **jobId** - *(Optional)* An ID that can be provided to more easily track the algorithm’s progress. *Default*: None (Generated internally).
984+
985+
* **logProgress** - *(Optional)* If disabled the progress percentage will not be logged. *Default*: True.
986+
987+
988+
953989
.. py:function:: gds.bridges.stream.estimate(G: Graph, **config: Any) -> Series[Any]
954990
955991
Returns an estimation of the memory consumption for that procedure.

0 commit comments

Comments
 (0)