Unverified Commit f3f646bb authored by Mufei Li's avatar Mufei Li Committed by GitHub
Browse files

[Doc and User Guide] Minor Fix (#2205)



* Fix doc and user guide

* Update heterograph.py
Co-authored-by: default avatarUbuntu <ubuntu@ip-172-31-13-9.us-west-2.compute.internal>
parent 39260242
...@@ -210,9 +210,9 @@ DGL implements ...@@ -210,9 +210,9 @@ DGL implements
`GIN <https://github.com/dmlc/dgl/tree/master/examples/pytorch/gin>`__ `GIN <https://github.com/dmlc/dgl/tree/master/examples/pytorch/gin>`__
as an example of graph classification. The training loop is inside the as an example of graph classification. The training loop is inside the
function ``train`` in function ``train`` in
```main.py`` <https://github.com/dmlc/dgl/blob/master/examples/pytorch/gin/main.py>`__. `main.py <https://github.com/dmlc/dgl/blob/master/examples/pytorch/gin/main.py>`__.
The model implementation is inside The model implementation is inside
```gin.py`` <https://github.com/dmlc/dgl/blob/master/examples/pytorch/gin/gin.py>`__ `gin.py <https://github.com/dmlc/dgl/blob/master/examples/pytorch/gin/gin.py>`__
with more components such as using with more components such as using
:class:`dgl.nn.pytorch.GINConv` (also available in MXNet and Tensorflow) :class:`dgl.nn.pytorch.GINConv` (also available in MXNet and Tensorflow)
as the graph convolution layer, batch normalization, etc. as the graph convolution layer, batch normalization, etc.
......
...@@ -240,8 +240,8 @@ class EdgeDataLoader: ...@@ -240,8 +240,8 @@ class EdgeDataLoader:
---------- ----------
g : DGLGraph g : DGLGraph
The graph. The graph.
nids : Tensor or dict[ntype, Tensor] eids : Tensor or dict[etype, Tensor]
The node set to compute outputs. The edge set in graph :attr:`g` to compute outputs.
block_sampler : dgl.dataloading.BlockSampler block_sampler : dgl.dataloading.BlockSampler
The neighborhood sampler. The neighborhood sampler.
g_sampling : DGLGraph, optional g_sampling : DGLGraph, optional
......
...@@ -2596,7 +2596,8 @@ class DGLHeteroGraph(object): ...@@ -2596,7 +2596,8 @@ class DGLHeteroGraph(object):
Parameters Parameters
---------- ----------
v : int v : int
The node ID. The node ID. If the graph has multiple edge types, the ID is for the destination
type corresponding to the edge type.
etype : str or (str, str, str), optional etype : str or (str, str, str), optional
The type names of the edges. The allowed type name formats are: The type names of the edges. The allowed type name formats are:
...@@ -2654,7 +2655,8 @@ class DGLHeteroGraph(object): ...@@ -2654,7 +2655,8 @@ class DGLHeteroGraph(object):
Parameters Parameters
---------- ----------
v : int v : int
The node ID. The node ID. If the graph has multiple edge types, the ID is for the source
type corresponding to the edge type.
etype : str or (str, str, str), optional etype : str or (str, str, str), optional
The type names of the edges. The allowed type name formats are: The type names of the edges. The allowed type name formats are:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment