README.md 1.03 KB
Newer Older
rusty1s's avatar
rusty1s committed
1
2
3
4
[build-image]: https://travis-ci.org/rusty1s/pytorch_scatter.svg?branch=master
[build-url]: https://travis-ci.org/rusty1s/pytorch_scatter

# PyTorch Scatter [![Build Status][build-image]][build-url]
rusty1s's avatar
rusty1s committed
5

rusty1s's avatar
rusty1s committed
6
<p align="center">
rusty1s's avatar
smaller  
rusty1s committed
7
  <img width="50%" src="https://raw.githubusercontent.com/rusty1s/pytorch_scatter/master/docs/source/_figures/add.svg?sanitize=true" />
rusty1s's avatar
rusty1s committed
8
9
10
11
</p>

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

rusty1s's avatar
rusty1s committed
12
13
14
15
16
17
18
19
20
21
* `scatter_add`
* `scatter_sub`
* `scatter_mul`
* `scatter_div`
* `scatter_mean`
* `scatter_min`
* `scatter_max`

## Installation

rusty1s's avatar
rusty1s committed
22
```sh
rusty1s's avatar
rusty1s committed
23
python setup.py install
rusty1s's avatar
rusty1s committed
24
25
```

rusty1s's avatar
rusty1s committed
26
27
## Usage

rusty1s's avatar
rusty1s committed
28
29
30
```py
from torch_scatter import scatter_max

rusty1s's avatar
typos  
rusty1s committed
31
32
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
33

Matthias Fey's avatar
Typo  
Matthias Fey committed
34
max, argmax = scatter_max(index, input, dim=1)
rusty1s's avatar
typo  
rusty1s committed
35
```
rusty1s's avatar
rusty1s committed
36

rusty1s's avatar
typo  
rusty1s committed
37
```
rusty1s's avatar
typos  
rusty1s committed
38
39
40
41
print(max)
 0  0  4  3  2  0
 2  4  3  0  0  0
[torch.FloatTensor of size 2x6]
rusty1s's avatar
rusty1s committed
42

rusty1s's avatar
typos  
rusty1s committed
43
44
45
46
47
print(argmax)
-1 -1  3  4  0  1
 1  4  3 -1 -1 -1
[torch.LongTensor of size 2x6]
```
rusty1s's avatar
rusty1s committed
48
49
50
51
52
53

## Running tests

```sh
python setup.py test
```