Skip to content

Commit 5f5542f

Browse files
committed
deprecate beta node2vec
1 parent 9c64658 commit 5f5542f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

doc/sphinx/source/ml.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,26 +77,44 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
7777
7878
HashGNN creates node embeddings by hashing and message passing.
7979

80+
.. deprecated:: 2.5.0
81+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.node2vec.mutate` instead.
82+
8083
.. py:function:: gds.beta.node2vec.mutate(G: Graph, **config: Any) -> Series[Any]
8184
8285
The Node2Vec algorithm computes embeddings for nodes based on random walks.
8386

87+
.. deprecated:: 2.5.0
88+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.node2vec.mutate.estimate` instead.
89+
8490
.. py:function:: gds.beta.node2vec.mutate.estimate(G: Graph, **config: Any) -> Series[Any]
8591
8692
Returns an estimation of the memory consumption for that procedure.
8793

94+
.. deprecated:: 2.5.0
95+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.node2vec.stream` instead.
96+
8897
.. py:function:: gds.beta.node2vec.stream(G: Graph, **config: Any) -> DataFrame
8998
9099
The Node2Vec algorithm computes embeddings for nodes based on random walks.
91100

101+
.. deprecated:: 2.5.0
102+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.node2vec.stream.estimate` instead.
103+
92104
.. py:function:: gds.beta.node2vec.stream.estimate(G: Graph, **config: Any) -> Series[Any]
93105
94106
Returns an estimation of the memory consumption for that procedure.
95107

108+
.. deprecated:: 2.5.0
109+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.node2vec.write` instead.
110+
96111
.. py:function:: gds.beta.node2vec.write(G: Graph, **config: Any) -> Series[Any]
97112
98113
The Node2Vec algorithm computes embeddings for nodes based on random walks.
99114

115+
.. deprecated:: 2.5.0
116+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.node2vec.write.estimate` instead.
117+
100118
.. py:function:: gds.beta.node2vec.write.estimate(G: Graph, **config: Any) -> Series[Any]
101119
102120
Returns an estimation of the memory consumption for that procedure.

0 commit comments

Comments
 (0)