[Doc] docstring for BatchedDGLGraph + some fix (#184)

* Update doc * Update batched_graph.py * Fix * Fix * Fix * Fix

[Doc] docstring for BatchedDGLGraph + some fix (#184)
* Update doc * Update batched_graph.py * Fix * Fix * Fix * Fix
8dc6784b · Mufei Li · Minjie Wang · e17c41c0 · 8dc6784b · 8dc6784b
Commit 8dc6784b authored Nov 29, 2018 by Mufei Li Committed by Minjie Wang Nov 29, 2018
Expand all Show whitespace changes
Inline Side-by-side

Showing with 416 additions and 66 deletions

docs/source/api/python/batch.rst docs/source/api/python/batch.rst +25 -3

python/dgl/batched_graph.py python/dgl/batched_graph.py +391 -63

No files found.
--- a/docs/source/api/python/batch.rst
+++ b/docs/source/api/python/batch.rst
-BatchedDGLGraph
-===============
+.. _apibatch:

-.. automodule:: dgl.batched_graph
+BatchedDGLGraph -- Enable batched graph operations
+==================================================
+
+.. currentmodule:: dgl
 .. autoclass:: BatchedDGLGraph

+Merge and decompose
+-------------------
+
 .. autosummary::
    :toctree: ../../generated/

    batch
    unbatch
+
+Query batch summary
+----------------------
+
+.. autosummary::
+    :toctree: ../../generated/
+
+    BatchedDGLGraph.batch_size
+    BatchedDGLGraph.batch_num_nodes
+    BatchedDGLGraph.batch_num_edges
+
+Graph Readout
+-------------
+
+.. autosummary::
+    :toctree: ../../generated/
+
    sum_nodes
    sum_edges
    mean_nodes

--- a/python/dgl/batched_graph.py
+++ b/python/dgl/batched_graph.py