README.md 2.61 KB
Newer Older
rusty1s's avatar
rusty1s committed
1
2
[pypi-image]: https://badge.fury.io/py/torch-scatter.svg
[pypi-url]: https://pypi.python.org/pypi/torch-scatter
rusty1s's avatar
rusty1s committed
3
[build-image]: https://travis-ci.org/rusty1s/pytorch_scatter.svg?branch=master [build-url]: https://travis-ci.org/rusty1s/pytorch_scatter
rusty1s's avatar
rusty1s committed
4
5
[coverage-image]: https://codecov.io/gh/rusty1s/pytorch_scatter/branch/master/graph/badge.svg
[coverage-url]: https://codecov.io/github/rusty1s/pytorch_scatter?branch=master
rusty1s's avatar
rusty1s committed
6

rusty1s's avatar
rusty1s committed
7
8
9
10
11
# PyTorch Scatter

[![PyPI Version][pypi-image]][pypi-url]
[![Build Status][build-image]][build-url]
[![Code Coverage][coverage-image]][coverage-url]
rusty1s's avatar
rusty1s committed
12

rusty1s's avatar
rusty1s committed
13
<p align="center">
rusty1s's avatar
smaller  
rusty1s committed
14
  <img width="50%" src="https://raw.githubusercontent.com/rusty1s/pytorch_scatter/master/docs/source/_figures/add.svg?sanitize=true" />
rusty1s's avatar
rusty1s committed
15
16
17
18
</p>

--------------------------------------------------------------------------------

rusty1s's avatar
rusty1s committed
19
20
**[Documentation](http://rusty1s.github.io/pytorch_scatter)**

rusty1s's avatar
rusty1s committed
21
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.
rusty1s's avatar
typo  
rusty1s committed
22
Scatter operations can be roughly described as reduce operations based on a given "group-index" tensor.
rusty1s's avatar
rusty1s committed
23
The package consists of the following operations:
rusty1s's avatar
rusty1s committed
24

rusty1s's avatar
rusty1s committed
25
26
27
28
29
30
31
* [**Scatter Add**](https://rusty1s.github.io/pytorch_scatter/build/html/functions/add.html)
* [**Scatter Sub**](https://rusty1s.github.io/pytorch_scatter/build/html/functions/sub.html)
* [**Scatter Mul**](https://rusty1s.github.io/pytorch_scatter/build/html/functions/mul.html)
* [**Scatter Div**](https://rusty1s.github.io/pytorch_scatter/build/html/functions/div.html)
* [**Scatter Mean**](https://rusty1s.github.io/pytorch_scatter/build/html/functions/mean.html)
* [**Scatter Min**](https://rusty1s.github.io/pytorch_scatter/build/html/functions/min.html)
* [**Scatter Max**](https://rusty1s.github.io/pytorch_scatter/build/html/functions/max.html)
rusty1s's avatar
rusty1s committed
32

rusty1s's avatar
rusty1s committed
33
All included operations work on varying data types, are implemented both for CPU and GPU and include a backwards implementation.
rusty1s's avatar
rusty1s committed
34

rusty1s's avatar
rusty1s committed
35
36
## Installation

rusty1s's avatar
rusty1s committed
37
38
39
40
Check that `nvcc` is accessible from terminal, e.g. `nvcc --version`.
If not, add cuda (`/usr/local/cuda/bin`) to your `$PATH`.
Then run:

rusty1s's avatar
rusty1s committed
41
```sh
rusty1s's avatar
rusty1s committed
42
pip install cffi torch-scatter
rusty1s's avatar
rusty1s committed
43
44
```

rusty1s's avatar
rusty1s committed
45
## Example
rusty1s's avatar
rusty1s committed
46

rusty1s's avatar
rusty1s committed
47
```py
rusty1s's avatar
typo  
rusty1s committed
48
import torch
rusty1s's avatar
rusty1s committed
49
50
from torch_scatter import scatter_max

rusty1s's avatar
typos  
rusty1s committed
51
52
input = torch.Tensor([[2, 0, 1, 4, 3], [0, 2, 1, 3, 4]])
index = torch.LongTensor([[4, 5, 4, 2, 3], [0, 0, 2, 2, 1]])
rusty1s's avatar
rusty1s committed
53

Matthias Fey's avatar
Typo  
Matthias Fey committed
54
max, argmax = scatter_max(index, input, dim=1)
rusty1s's avatar
typo  
rusty1s committed
55
```
rusty1s's avatar
rusty1s committed
56

rusty1s's avatar
typo  
rusty1s committed
57
```
rusty1s's avatar
typos  
rusty1s committed
58
59
60
61
print(max)
 0  0  4  3  2  0
 2  4  3  0  0  0
[torch.FloatTensor of size 2x6]
rusty1s's avatar
rusty1s committed
62

rusty1s's avatar
typos  
rusty1s committed
63
64
65
66
67
print(argmax)
-1 -1  3  4  0  1
 1  4  3 -1 -1 -1
[torch.LongTensor of size 2x6]
```
rusty1s's avatar
rusty1s committed
68
69
70

## Running tests

rusty1s's avatar
rusty1s committed
71
```sh
rusty1s's avatar
rusty1s committed
72
73
python setup.py test
```