Files
dgl/docs/source/api/python/dgl.dataloading.rst
Quan (Andy) Gan cd48435206 [Transform] Docstring and subframes (#1962)
* update knn graph docs

* more docs

* [Doc] transform module docstrings

* remove copy_ndata and copy_edata

* fix

* lint

* fix

* fix

* fix

* clean up docstrings

* fix docstring

* dtype specifications

* addresses comments

* fix

Co-authored-by: Mufei Li <mufeili1996@gmail.com>
Co-authored-by: xiang song(charlie.song) <classicxsong@gmail.com>
2020-08-13 10:41:43 +08:00

57 lines
1.1 KiB
ReStructuredText

.. _api-dataloading:
dgl.dataloading
=================================
.. automodule:: dgl.dataloading
DataLoaders
-----------
PyTorch node/edge DataLoaders
`````````````````````````````
.. currentmodule:: dgl.dataloading.pytorch
.. autoclass:: NodeDataLoader
.. autoclass:: EdgeDataLoader
General collating functions
```````````````````````````
.. currentmodule:: dgl.dataloading
.. autoclass:: Collator
:members: dataset, collate
.. autoclass:: NodeCollator
:members: dataset, collate
.. autoclass:: EdgeCollator
:members: dataset, collate
Neighborhood Sampling Classes
-----------------------------
Base Multi-layer Neighborhood Sampling Class
````````````````````````````````````````````
.. autoclass:: BlockSampler
:members: sample_frontier, sample_blocks
Uniform Node-wise Neighbor Sampling (GraphSAGE style)
`````````````````````````````````````````````````````
.. autoclass:: MultiLayerNeighborSampler
:members: sample_frontier
.. _negative-sampling:
Negative Samplers for Link Prediction
-------------------------------------
.. currentmodule:: dgl.dataloading.negative_sampler
.. autoclass:: Uniform
:members: __call__