update doc

Author: rusty1s

.travis.yml

@@ -39,6 +39,7 @@ install:
   - pip install codecov
   - pip install sphinx
   - pip install sphinx_rtd_theme
+  - pip install sphinx-autodoc-typehints
 script:
   - python -c "import torch; print(torch.__version__)"
   - pycodestyle .

README.md

@@ -22,22 +22,17 @@
 
 **[Documentation](https://pytorch-scatter.readthedocs.io)**
 
-This package consists of a small extension library of highly optimized sparse update (scatter/segment) operations for the use in [PyTorch](http://pytorch.org/), which are missing in the main package.
+This package consists of a small extension library of highly optimized sparse update (scatter and segment) operations for the use in [PyTorch](http://pytorch.org/), which are missing in the main package.
 Scatter and segment operations can be roughly described as reduce operations based on a given "group-index" tensor.
-The package consists of the following operations:
+Segment operations require the "group-index" tensor to be sorted, whereas scatter operations are not subject to these requirements.
 
-* [**Scatter**](https://pytorch-scatter.readthedocs.io/en/latest/functions/add.html)
-* [**SegmentCOO**](https://pytorch-scatter.readthedocs.io/en/latest/functions/add.html)
-* [**SegmentCSR**](https://pytorch-scatter.readthedocs.io/en/latest/functions/add.html)
+The package consists of the following operations with reduction types `"sum"|"mean"|"min"|"max"`:
 
-In addition, we provide composite functions which make use of `scatter_*` operations under the hood:
+* [**scatter**](https://pytorch-scatter.readthedocs.io/en/latest/functions/segment.html) based on arbitrary indices
+* [**segment_coo**](https://pytorch-scatter.readthedocs.io/en/latest/functions/segment_coo.html) based on sorted indices
+* [**segment_csr**](https://pytorch-scatter.readthedocs.io/en/latest/functions/segment_csr.html) based on compressed indices via pointers
 
-* [**Scatter Std**](https://pytorch-scatter.readthedocs.io/en/latest/composite/softmax.html#torch_scatter.composite.scatter_std)
-* [**Scatter LogSumExp**](https://pytorch-scatter.readthedocs.io/en/latest/composite/softmax.html#torch_scatter.composite.scatter_logsumexp)
-* [**Scatter Softmax**](https://pytorch-scatter.readthedocs.io/en/latest/composite/softmax.html#torch_scatter.composite.scatter_softmax)
-* [**Scatter LogSoftmax**](https://pytorch-scatter.readthedocs.io/en/latest/composite/softmax.html#torch_scatter.composite.scatter_log_softmax)
-
-All included operations are broadcastable, work on varying data types, are implemented both for CPU and GPU with corresponding backward implementations, and are fully traceable via `@torch.jit.script`.
+All included operations are broadcastable, work on varying data types, are implemented both for CPU and GPU with corresponding backward implementations, and are fully traceable.
 
 ## Installation
 

docs/requirements.txt

@@ -3,3 +3,4 @@ numpy
 torch_nightly
 sphinx
 sphinx_rtd_theme
+sphinx-autodoc-typehints

docs/source/composite/softmax.rst

@@ -11,6 +11,7 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
+    'sphinx_autodoc_typehints',
 ]
 
 source_suffix = '.rst'

docs/source/conf.py

@@ -1,7 +1,7 @@
-Scatter Add
-===========
+Scatter
+=======
 
 .. automodule:: torch_scatter
    :noindex:
 
-.. autofunction:: scatter_add
+.. autofunction:: scatter