dmlc--dgl
Minjie Wang
f13b9b6212
* WIP: api * dgl.sampling, dgl.data * dgl.sampling; dgl.dataloading * sampling packages * convert * subgraph * deprecate * subgraph APIs * All docstrings for convert/subgraph/transform * almost all funcs under dgl namespace * WIP: DGLGraph * done graph query * message passing functions * lint * fix merge error * fix test * lint * fix Co-authored-by: Quan Gan <coin2028@hotmail.com>
51 行
1.5 KiB
ReStructuredText
51 行
1.5 KiB
ReStructuredText
.. _api-dataloading:
|
|
|
|
dgl.dataloading
|
|
=================================
|
|
|
|
.. automodule:: dgl.dataloading
|
|
|
|
DataLoaders
|
|
-----------
|
|
.. currentmodule:: dgl.dataloading.pytorch
|
|
|
|
DGL DataLoader for mini-batch training works similarly to PyTorch's DataLoader.
|
|
It has a generator interface that returns mini-batches sampled from some given graphs.
|
|
DGL provides two DataLoaders: a ``NodeDataLoader`` for node classification task
|
|
and an ``EdgeDataLoader`` for edge/link prediction task.
|
|
|
|
.. autoclass:: NodeDataLoader
|
|
.. autoclass:: EdgeDataLoader
|
|
|
|
.. _api-dataloading-neighbor-sampling:
|
|
Neighbor Sampler
|
|
-----------------------------
|
|
.. currentmodule:: dgl.dataloading.neighbor
|
|
|
|
Neighbor samplers are classes that control the behavior of ``DataLoader`` s
|
|
to sample neighbors. All of them inherit the base :class:`BlockSampler` class, but implement
|
|
different neighbor sampling strategies by overriding the ``sample_frontier`` or
|
|
the ``sample_blocks`` methods.
|
|
|
|
.. autoclass:: BlockSampler
|
|
:members: sample_frontier, sample_blocks
|
|
|
|
.. autoclass:: MultiLayerNeighborSampler
|
|
:members: sample_frontier
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: MultiLayerFullNeighborSampler
|
|
:show-inheritance:
|
|
|
|
.. _api-dataloading-negative-sampling:
|
|
|
|
Negative Samplers for Link Prediction
|
|
-------------------------------------
|
|
.. currentmodule:: dgl.dataloading.negative_sampler
|
|
|
|
Negative samplers are classes that control the behavior of the ``EdgeDataLoader``
|
|
to generate negative edges.
|
|
|
|
.. autoclass:: Uniform
|
|
:members: __call__
|