Skip to content

Commit 517a96e

Browse files
committed
Remove duplicate listing of cliqueCounting
1 parent 21a0d3a commit 517a96e

File tree

3 files changed

+7
-41
lines changed

3 files changed

+7
-41
lines changed

doc/sphinx/algorithms.json

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3593,37 +3593,5 @@
35933593
"return_type": "float"
35943594
},
35953595
"description": "Given two nodes, calculate Total Neighbors"
3596-
},
3597-
{
3598-
"function": {
3599-
"name": "gds.cliqueCounting.mutate",
3600-
"signature": "G: Graph, **config: Any",
3601-
"return_type": "DataFrame"
3602-
},
3603-
"description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
3604-
},
3605-
{
3606-
"function": {
3607-
"name": "gds.cliqueCounting.stats",
3608-
"signature": "G: Graph, **config: Any",
3609-
"return_type": "DataFrame"
3610-
},
3611-
"description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
3612-
},
3613-
{
3614-
"function": {
3615-
"name": "gds.cliqueCounting.stream",
3616-
"signature": "G: Graph, **config: Any",
3617-
"return_type": "DataFrame"
3618-
},
3619-
"description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
3620-
},
3621-
{
3622-
"function": {
3623-
"name": "gds.cliqueCounting.write",
3624-
"signature": "G: Graph, **config: Any",
3625-
"return_type": "DataFrame"
3626-
},
3627-
"description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
36283596
}
36293597
]

doc/sphinx/create_algorithms_rst.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
import json
2-
import os
32
from pathlib import Path
43
from textwrap import dedent
5-
from typing import Any
64

75
root_dir = Path(__file__).parent
86

doc/sphinx/source/algorithms.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -816,21 +816,21 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
816816
817817
Returns an estimation of the memory consumption for that procedure.
818818

819-
.. py:function:: gds.cliqueCounting.mutate(G: Graph, **config: Any) -> DataFrame
819+
.. py:function:: gds.cliqueCounting.mutate(G: Graph, **config: Any) -> Series[Any]
820820
821-
The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
821+
Counts the number of cliques, of different size, each node is part of.
822822

823-
.. py:function:: gds.cliqueCounting.stats(G: Graph, **config: Any) -> DataFrame
823+
.. py:function:: gds.cliqueCounting.stats(G: Graph, **config: Any) -> Series[Any]
824824
825-
The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
825+
Counts the number of cliques, of different size, in the entire graph.
826826

827827
.. py:function:: gds.cliqueCounting.stream(G: Graph, **config: Any) -> DataFrame
828828
829-
The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
829+
Counts the number of cliques, of different size, each node is part of.
830830

831-
.. py:function:: gds.cliqueCounting.write(G: Graph, **config: Any) -> DataFrame
831+
.. py:function:: gds.cliqueCounting.write(G: Graph, **config: Any) -> Series[Any]
832832
833-
The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
833+
Counts the number of cliques, of different size, each node is part of.
834834

835835
.. py:function:: gds.closeness.harmonic.mutate(G: Graph, **config: Any) -> DataFrame
836836

0 commit comments

Comments
 (0)