Files
dgl/docs/source/api/python/traversal.rst
Minjie Wang 5967d81782 [Doc] Re-organize API docs and tutorials (#1222)
* reorg tutorials and api docs

* fix
2020-01-26 21:26:34 +08:00

24 lines
598 B
ReStructuredText

dgl.traversal
===============
.. automodule:: dgl.traversal
Graph traversal algorithms implemented as python generators, which returns the visited set
of nodes or edges at each iteration. The naming convention
is ``<algorithm>_[nodes|edges]_generator``. An example usage is as follows.
.. code:: python
g = ... # some DGLGraph
for nodes in dgl.bfs_nodes_generator(g, 0):
do_something(nodes)
.. autosummary::
:toctree: ../../generated/
bfs_nodes_generator
bfs_edges_generator
topological_nodes_generator
dfs_edges_generator
dfs_labeled_edges_generator