Skip to content

Commit 38077e2

Browse files
authored
installation and doc fix (dmlc#2379)
1 parent edb9787 commit 38077e2

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

docs/source/install/index.rst

+3
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ After the ``conda`` environment is activated, run one of the following commands.
3636
conda install -c dglteam dgl-cuda10.0 # For CUDA 10.0 Build
3737
conda install -c dglteam dgl-cuda10.1 # For CUDA 10.1 Build
3838
conda install -c dglteam dgl-cuda10.2 # For CUDA 10.2 Build
39+
conda install -c dglteam dgl-cuda11.0 # For CUDA 11.0 Build
3940
4041
4142
Install from pip
@@ -56,6 +57,7 @@ For CUDA builds, run one of the following commands and specify the CUDA version.
5657
pip install dgl-cu100 # For CUDA 10.0 Build
5758
pip install dgl-cu101 # For CUDA 10.1 Build
5859
pip install dgl-cu102 # For CUDA 10.2 Build
60+
pip install dgl-cu110 # For CUDA 11.0 Build
5961
6062
For the most current nightly build from master branch, run one of the following commands.
6163

@@ -67,6 +69,7 @@ For the most current nightly build from master branch, run one of the following
6769
pip install --pre dgl-cu100 # For CUDA 10.0 Build
6870
pip install --pre dgl-cu101 # For CUDA 10.1 Build
6971
pip install --pre dgl-cu102 # For CUDA 10.2 Build
72+
pip install --pre dgl-cu110 # For CUDA 11.0 Build
7073
7174
7275
.. _install-from-source:

python/dgl/dataloading/pytorch/__init__.py

+20-2
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,23 @@ class EdgeDataLoader:
236236
of blocks as computation dependency of the said minibatch for edge classification,
237237
edge regression, and link prediction.
238238
239+
For each iteration, the object will yield
240+
241+
* A tensor of input nodes necessary for computing the representation on edges, or
242+
a dictionary of node type names and such tensors.
243+
244+
* A subgraph that contains only the edges in the minibatch and their incident nodes.
245+
Note that the graph has an identical metagraph with the original graph.
246+
247+
* If a negative sampler is given, another graph that contains the "negative edges",
248+
connecting the source and destination nodes yielded from the given negative sampler.
249+
250+
* A list of blocks necessary for computing the representation of the incident nodes
251+
of the edges in the minibatch.
252+
253+
For more details, please refer to :ref:`guide-minibatch-edge-classification-sampler`
254+
and :ref:`guide-minibatch-link-classification-sampler`.
255+
239256
Parameters
240257
----------
241258
g : DGLGraph
@@ -301,8 +318,9 @@ class EdgeDataLoader:
301318
>>> reverse_eids = torch.cat([torch.arange(E, 2 * E), torch.arange(0, E)])
302319
303320
Note that the sampled edges as well as their reverse edges are removed from
304-
computation dependencies of the incident nodes. This is a common trick to avoid
305-
information leakage.
321+
computation dependencies of the incident nodes. That is, the edge will not
322+
involve in neighbor sampling and message aggregation. This is a common trick
323+
to avoid information leakage.
306324
307325
>>> sampler = dgl.dataloading.MultiLayerNeighborSampler([15, 10, 5])
308326
>>> dataloader = dgl.dataloading.EdgeDataLoader(

0 commit comments

Comments
 (0)