doc fixes

Author: rusty1s

build.py

@@ -1,13 +1,9 @@
 import os.path as osp
-import shutil
 import subprocess
 
 import torch
 from torch.utils.ffi import create_extension
 
-if osp.exists('build'):
-    shutil.rmtree('build')
-
 headers = ['torch_scatter/src/cpu.h']
 sources = ['torch_scatter/src/cpu.c']
 include_dirs = ['torch_scatter/src']

docs/source/conf.py

@@ -1,11 +1,7 @@
-import os
-import sys
 import datetime
 import sphinx_rtd_theme
 import doctest
 
-sys.path.insert(0, os.path.abspath('../..'))
-
 from torch_scatter import __version__  # noqa
 
 extensions = [

docs/source/functions/add.rst

@@ -3,5 +3,4 @@ Scatter Add
 
 .. automodule:: torch_scatter
 
-.. autofunction:: scatter_add_
 .. autofunction:: scatter_add

docs/source/functions/div.rst

@@ -3,5 +3,4 @@ Scatter Div
 
 .. automodule:: torch_scatter
 
-.. autofunction:: scatter_div_
 .. autofunction:: scatter_div

docs/source/functions/max.rst

@@ -3,5 +3,4 @@ Scatter Max
 
 .. automodule:: torch_scatter
 
-.. autofunction:: scatter_max_
 .. autofunction:: scatter_max

docs/source/functions/mean.rst

@@ -3,5 +3,4 @@ Scatter Mean
 
 .. automodule:: torch_scatter
 
-.. autofunction:: scatter_mean_
 .. autofunction:: scatter_mean

docs/source/functions/min.rst

@@ -3,5 +3,4 @@ Scatter Min
 
 .. automodule:: torch_scatter
 
-.. autofunction:: scatter_min_
 .. autofunction:: scatter_min

docs/source/functions/mul.rst

@@ -3,5 +3,4 @@ Scatter Mul
 
 .. automodule:: torch_scatter
 
-.. autofunction:: scatter_mul_
 .. autofunction:: scatter_mul

docs/source/functions/sub.rst

@@ -3,5 +3,4 @@ Scatter Sub
 
 .. automodule:: torch_scatter
 
-.. autofunction:: scatter_sub_
 .. autofunction:: scatter_sub

torch_scatter/add.py

@@ -50,7 +50,7 @@ def scatter_add(src, index, dim=-1, out=None, dim_size=None, fill_value=0):
     .. math::
         \mathrm{out}_i = \mathrm{out}_i + \sum_j \mathrm{src}_j
 
-    where :math:`\sum` is over :math:`j` such that
+    where :math:`\sum_j` is over :math:`j` such that
     :math:`\mathrm{index}_j = i`.
 
     Args:
@@ -75,17 +75,19 @@ def scatter_add(src, index, dim=-1, out=None, dim_size=None, fill_value=0):
     .. testcode::
 
         from torch_scatter import scatter_add
+
         src = torch.tensor([[2, 0, 1, 4, 3], [0, 2, 1, 3, 4]])
         index = torch.tensor([[4, 5, 4, 2, 3], [0, 0, 2, 2, 1]])
         out = src.new_zeros((2, 6))
+
         out = scatter_add(src, index, out=out)
+
         print(out)
 
     .. testoutput::
 
-        0  0  4  3  3  0
-        2  4  4  0  0  0
-       [torch.FloatTensor of size 2x6]
+       tensor([[ 0,  0,  4,  3,  3,  0],
+               [ 2,  4,  4,  0,  0,  0]])
     """
     src, out, index, dim = gen(src, index, dim, out, dim_size, fill_value)
     return ScatterAdd.apply(out, src, index, dim)