Files
dgl/docs/source/api/python/sampler.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

41 lines
891 B
ReStructuredText

.. apisampler
dgl.contrib.sampling
======================
Module for sampling algorithms on graph. Each algorithm is implemented as a
data loader, which produces sampled subgraphs (called Nodeflow) at each
iteration.
.. autofunction:: dgl.contrib.sampling.sampler.NeighborSampler
.. autofunction:: dgl.contrib.sampling.sampler.LayerSampler
.. autofunction:: dgl.contrib.sampling.sampler.EdgeSampler
Distributed sampler
------------------------
.. currentmodule:: dgl.contrib.sampling.dis_sampler
.. autoclass:: SamplerPool
.. autosummary::
:toctree: ../../generated/
SamplerPool.start
SamplerPool.worker
.. autoclass:: SamplerSender
.. autosummary::
:toctree: ../../generated/
SamplerSender.send
SamplerSender.signal
.. autoclass:: SamplerReceiver
.. autosummary::
:toctree: ../../generated/
SamplerReceiver.__iter__
SamplerReceiver.__next__