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

* Update doc * Update batched_graph.py * Fix * Fix * Fix * Fix
SunYa0 · Nov 29, 2018 · 8dc6784 · 8dc6784
1 parent e17c41c
commit 8dc6784
Show file tree

Hide file tree

Showing 2 changed files with 416 additions and 66 deletions.
diff --git a/docs/source/api/python/batch.rst b/docs/source/api/python/batch.rst
@@ -1,14 +1,36 @@
-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