fixed version call, added readme

README.md

@@ -11,8 +11,9 @@
 
 --------------------------------------------------------------------------------
 
-This package consists of a small extension library of highly optimised sparse update operations for the use in [PyTorch](http://pytorch.org/).
-It consists of the following operations:
+This package consists of a small extension library of highly optimised sparse update (scatter) operations for the use in [PyTorch](http://pytorch.org/), which are missing in the main package.
+Scatter-operations can be roughly described as reduce-operations based on a given "group-index" tensor.
+The package consists of the following operations:
 
 * `scatter_add`
 * `scatter_sub`
@@ -22,7 +23,7 @@ It consists of the following operations:
 * `scatter_min`
 * `scatter_max`
 
-All included `scatter` ops work on varying data types, are implemented both for CPU and GPU and include a backwards implementation.
+All included operations work on varying data types, are implemented both for CPU and GPU and include a backwards implementation.
 
 ## Installation
 

docs/source/index.rst

@@ -3,6 +3,11 @@
 PyTorch Scatter documentation
 ===============================
 
+This package consists of a small extension library of highly optimised sparse update (scatter) operations for the use in `PyTorch <http://pytorch.org/>`_, which are missing in the main package.
+Scatter-operations can be roughly described as reduce-operations based on a given "group-index" tensor.
+
+All included operations work on varying data types, are implemented both for CPU and GPU and include a backwards implementation.
+
 .. toctree::
    :glob:
    :maxdepth: 1

setup.py

 from os import path as osp
+
 from setuptools import setup, find_packages
 
-filename = osp.join(osp.dirname(osp.abspath('__file__')), 'VERSION')
+filename = osp.join(osp.dirname(__file__), 'VERSION')
 with open(filename, 'r') as f:
     version = f.read().strip()
 

torch_scatter/__init__.py

@@ -8,7 +8,7 @@ from .functions.mean import scatter_mean_, scatter_mean
 from .functions.max import scatter_max_, scatter_max
 from .functions.min import scatter_min_, scatter_min
 
-filename = osp.join(osp.dirname(osp.abspath('__file__')), 'VERSION')
+filename = osp.join(osp.dirname(__file__), '..', 'VERSION')
 with open(filename, 'r') as f:
     __version__ = f.read().strip()