index.rst 752 Bytes
Newer Older
rusty1s's avatar
rusty1s committed
1
2
:github_url: https://github.com/rusty1s/pytorch_scatter

rusty1s's avatar
typo  
rusty1s committed
3
4
PyTorch Scatter Documentation
=============================
rusty1s's avatar
rusty1s committed
5

rusty1s's avatar
rusty1s committed
6
This package consists of a small extension library of highly optimized 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
7
Scatter operations can be roughly described as reduce operations based on a given "group-index" tensor.
rusty1s's avatar
rusty1s committed
8

rusty1s's avatar
rusty1s committed
9
All included operations are broadcastable, work on varying data types, and are implemented both for CPU and GPU with corresponding backward implementations.
rusty1s's avatar
rusty1s committed
10

rusty1s's avatar
rusty1s committed
11
12
13
.. toctree::
   :glob:
   :maxdepth: 1
rusty1s's avatar
rusty1s committed
14
15
16
   :caption: Package reference

   functions/*
17
   composite/*
rusty1s's avatar
rusty1s committed
18
19
20
21
22
23

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`