Unverified Commit fcf11935 authored by Xiangkun Hu's avatar Xiangkun Hu Committed by GitHub
Browse files

[Doc] Hidden implementations that may cause confusion to the user. (#2378)

* PPIDataset

* Revert "PPIDataset"

This reverts commit 264bd0c960cfa698a7bb946dad132bf52c2d0c8a.

* data pipeline user guide

* remove chapter numbers

* Update data.rst

* image in dataset userguide

* update links using ref

* modify the link of save_graphs and load_graphs in dataset user guide

* move image to s3 server.

* fix links and ref

* Hide implementations that may cause confusions to the user
parent 98e11533
...@@ -143,7 +143,7 @@ builtin dataset `CitationGraphDataset <https://docs.dgl.ai/en/0.5.x/_modules/dgl ...@@ -143,7 +143,7 @@ builtin dataset `CitationGraphDataset <https://docs.dgl.ai/en/0.5.x/_modules/dgl
.. code:: .. code::
from dgl.data import DGLBuiltinDataset from dgl.data import DGLBuiltinDataset
from dgl.data.utils import _get_dgl_url, generate_mask_tensor from dgl.data.utils import _get_dgl_url
class CitationGraphDataset(DGLBuiltinDataset): class CitationGraphDataset(DGLBuiltinDataset):
_urls = { _urls = {
...@@ -170,9 +170,9 @@ builtin dataset `CitationGraphDataset <https://docs.dgl.ai/en/0.5.x/_modules/dgl ...@@ -170,9 +170,9 @@ builtin dataset `CitationGraphDataset <https://docs.dgl.ai/en/0.5.x/_modules/dgl
# build graph # build graph
g = dgl.graph(graph) g = dgl.graph(graph)
# splitting masks # splitting masks
g.ndata['train_mask'] = generate_mask_tensor(train_mask) g.ndata['train_mask'] = train_mask
g.ndata['val_mask'] = generate_mask_tensor(val_mask) g.ndata['val_mask'] = val_mask
g.ndata['test_mask'] = generate_mask_tensor(test_mask) g.ndata['test_mask'] = test_mask
# node labels # node labels
g.ndata['label'] = torch.tensor(labels) g.ndata['label'] = torch.tensor(labels)
# node features # node features
......
...@@ -126,7 +126,7 @@ DGL建议使用节点掩码来指定数据集的划分。 ...@@ -126,7 +126,7 @@ DGL建议使用节点掩码来指定数据集的划分。
.. code:: .. code::
from dgl.data import DGLBuiltinDataset from dgl.data import DGLBuiltinDataset
from dgl.data.utils import _get_dgl_url, generate_mask_tensor from dgl.data.utils import _get_dgl_url
class CitationGraphDataset(DGLBuiltinDataset): class CitationGraphDataset(DGLBuiltinDataset):
_urls = { _urls = {
...@@ -154,9 +154,9 @@ DGL建议使用节点掩码来指定数据集的划分。 ...@@ -154,9 +154,9 @@ DGL建议使用节点掩码来指定数据集的划分。
g = dgl.graph(graph) g = dgl.graph(graph)
# 划分掩码 # 划分掩码
g.ndata['train_mask'] = generate_mask_tensor(train_mask) g.ndata['train_mask'] = train_mask
g.ndata['val_mask'] = generate_mask_tensor(val_mask) g.ndata['val_mask'] = val_mask
g.ndata['test_mask'] = generate_mask_tensor(test_mask) g.ndata['test_mask'] = test_mask
# 节点的标签 # 节点的标签
g.ndata['label'] = torch.tensor(labels) g.ndata['label'] = torch.tensor(labels)
......
...@@ -114,16 +114,16 @@ class CitationGraphDataset(DGLBuiltinDataset): ...@@ -114,16 +114,16 @@ class CitationGraphDataset(DGLBuiltinDataset):
idx_train = range(len(y)) idx_train = range(len(y))
idx_val = range(len(y), len(y)+500) idx_val = range(len(y), len(y)+500)
train_mask = _sample_mask(idx_train, labels.shape[0]) train_mask = generate_mask_tensor(_sample_mask(idx_train, labels.shape[0]))
val_mask = _sample_mask(idx_val, labels.shape[0]) val_mask = generate_mask_tensor(_sample_mask(idx_val, labels.shape[0]))
test_mask = _sample_mask(idx_test, labels.shape[0]) test_mask = generate_mask_tensor(_sample_mask(idx_test, labels.shape[0]))
self._graph = graph self._graph = graph
g = from_networkx(graph) g = from_networkx(graph)
g.ndata['train_mask'] = generate_mask_tensor(train_mask) g.ndata['train_mask'] = train_mask
g.ndata['val_mask'] = generate_mask_tensor(val_mask) g.ndata['val_mask'] = val_mask
g.ndata['test_mask'] = generate_mask_tensor(test_mask) g.ndata['test_mask'] = test_mask
g.ndata['label'] = F.tensor(labels) g.ndata['label'] = F.tensor(labels)
g.ndata['feat'] = F.tensor(_preprocess_features(features), dtype=F.data_type_dict['float32']) g.ndata['feat'] = F.tensor(_preprocess_features(features), dtype=F.data_type_dict['float32'])
self._num_classes = onehot_labels.shape[1] self._num_classes = onehot_labels.shape[1]
......
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