Metadata-Version: 2.4
Name: pyg_lib
Version: 0.4.0
Summary: Low-Level Graph Neural Network Operators for PyG
Home-page: https://github.com/pyg-team/pyg-lib
Download-URL: https://github.com/pyg-team/pyg-lib/archive/0.4.0.tar.gz
Author: PyG Team
Author-email: team@pyg.org
Keywords: deep-learning,pytorch,geometric-deep-learning,graph-neural-networks,graph-convolutional-networks
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE_radix_sort
Provides-Extra: triton
Requires-Dist: triton; extra == "triton"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-python
Dynamic: summary

[python-testing-image]: https://github.com/pyg-team/pyg-lib/actions/workflows/python_testing.yml/badge.svg
[python-testing-url]: https://github.com/pyg-team/pyg-lib/actions/workflows/python_testing.yml
[cpp-testing-image]: https://github.com/pyg-team/pyg-lib/actions/workflows/cpp_testing.yml/badge.svg
[cpp-testing-url]: https://github.com/pyg-team/pyg-lib/actions/workflows/cpp_testing.yml
[docs-image]: https://readthedocs.org/projects/pyg-lib/badge/?version=latest
[docs-url]: https://pyg-lib.readthedocs.io/en/latest/?badge=latest
[coverage-image]: https://codecov.io/gh/pyg-team/pyg-lib/branch/master/graph/badge.svg
[coverage-url]: https://codecov.io/github/pyg-team/pyg-lib?branch=master

# pyg-lib

[![Python Testing Status][python-testing-image]][python-testing-url]
[![CPP Testing Status][cpp-testing-image]][cpp-testing-url]
[![Docs Status][docs-image]][docs-url]
[![Code Coverage][coverage-image]][coverage-url]

* [Installation](#installation)

## Installation

We provide pre-built Python wheels for all major OS/PyTorch/CUDA combinations from Python 3.8 till 3.12, see [here](https://data.pyg.org/whl).
Note that currently, Windows wheels are not supported (we are working on fixing this as soon as possible).

To install the wheels, simply run

```
pip install pyg-lib -f https://data.pyg.org/whl/torch-${TORCH}+${CUDA}.html
```

where

* `${TORCH}` should be replaced by either `1.12.0`, `1.13.0`, `2.0.0`, `2.1.0`, or `2.2.0`
* `${CUDA}` should be replaced by either `cpu`, `cu102`, `cu113`, `cu116`, `cu117`, `cu118`, or `cu121`

The following combinations are supported:

| PyTorch 2.2  | `cpu` | `cu102` | `cu113` | `cu116` | `cu117` | `cu118` | `cu121` |
|--------------|-------|---------|---------|---------|---------|---------|---------|
| **Linux**    | ✅    |         |         |         |         | ✅      | ✅      |
| **Windows**  |       |         |         |         |         |         |         |
| **macOS**    | ✅    |         |         |         |         |         |         |

| PyTorch 2.1  | `cpu` | `cu102` | `cu113` | `cu116` | `cu117` | `cu118` | `cu121` |
|--------------|-------|---------|---------|---------|---------|---------|---------|
| **Linux**    | ✅    |         |         |         |         | ✅      | ✅      |
| **Windows**  |       |         |         |         |         |         |         |
| **macOS**    | ✅    |         |         |         |         |         |         |

| PyTorch 2.0  | `cpu` | `cu102` | `cu113` | `cu116` | `cu117` | `cu118` | `cu121` |
|--------------|-------|---------|---------|---------|---------|---------|---------|
| **Linux**    | ✅    |         |         |         | ✅      | ✅      |         |
| **Windows**  |       |         |         |         |         |         |         |
| **macOS**    | ✅    |         |         |         |         |         |         |

| PyTorch 1.13 | `cpu` | `cu102` | `cu113` | `cu116` | `cu117` | `cu118` | `cu121` |
|--------------|-------|---------|---------|---------|---------|---------|---------|
| **Linux**    | ✅    |         |         | ✅      | ✅      |         |         |
| **Windows**  |       |         |         |         |         |         |         |
| **macOS**    | ✅    |         |         |         |         |         |         |

| PyTorch 1.12 | `cpu` | `cu102` | `cu113` | `cu116` | `cu117` | `cu118` | `cu121` |
|--------------|-------|---------|---------|---------|---------|---------| --------|
| **Linux**    | ✅    | ✅      | ✅      | ✅      |         |         |         |
| **Windows**  |       |         |         |         |         |         |         |
| **macOS**    | ✅    |         |         |         |         |         |         |

### Form nightly

Nightly wheels are provided for Linux from Python 3.8 till 3.12:

```
pip install pyg-lib -f https://data.pyg.org/whl/nightly/torch-${TORCH}+${CUDA}.html
```

### From master

```
pip install ninja wheel
pip install git+https://github.com/pyg-team/pyg-lib.git
```
