Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/intelpython/dpnp

Data Parallel Extension for NumPy
https://github.com/intelpython/dpnp

dpcpp gpu gpu-acceleration intel mkl numpy oneapi pstl python3 sycl

Last synced: about 1 month ago
JSON representation

Data Parallel Extension for NumPy

Host: GitHub
URL: https://github.com/intelpython/dpnp
Owner: IntelPython
License: bsd-2-clause
Created: 2020-09-04T15:29:11.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-04-26T16:52:21.000Z (7 months ago)
Last Synced: 2024-04-26T18:33:26.880Z (7 months ago)
Topics: dpcpp, gpu, gpu-acceleration, intel, mkl, numpy, oneapi, pstl, python3, sycl
Language: Python
Homepage:
Size: 190 MB
Stars: 91
Watchers: 12
Forks: 22
Open Issues: 96
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![Pre-commit](https://github.com/IntelPython/dpnp/actions/workflows/pre-commit.yml/badge.svg?branch=master&event=push)](https://github.com/IntelPython/dpnp/actions/workflows/pre-commit.yml)

[![Conda package](https://github.com/IntelPython/dpnp/actions/workflows/conda-package.yml/badge.svg?branch=master&event=push)](https://github.com/IntelPython/dpnp/actions/workflows/conda-package.yml)

[![Coverage Status](https://coveralls.io/repos/github/IntelPython/dpnp/badge.svg?branch=master)](https://coveralls.io/github/IntelPython/dpnp?branch=master)

[![Build Sphinx](https://github.com/IntelPython/dpnp/workflows/Build%20Sphinx/badge.svg)](https://intelpython.github.io/dpnp)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/IntelPython/dpnp/badge)](https://securityscorecards.dev/viewer/?uri=github.com/IntelPython/dpnp)

# DPNP - Data Parallel Extension for NumPy*

[API coverage summary](https://intelpython.github.io/dpnp/reference/comparison.html#summary)

[Full documentation](https://intelpython.github.io/dpnp/)

[DPNP C++ backend documentation](https://intelpython.github.io/dpnp/backend_doc/)

## Build from source:

Ensure you have the following prerequisite packages installed:

- `cython`

- `cmake >=3.21`

- `dpcpp_linux-64` or `dpcpp_win-64` (depending on your OS)

- `dpctl`

- `mkl-devel-dpcpp`

- `onedpl-devel`

- `ninja`

- `numpy >=1.19,<1.25a0`

- `python`

- `scikit-build`

- `setuptools`

- `sysroot_linux-64 >=2.28` (only on Linux OS)

- `tbb-devel`

After these steps, `dpnp` can be built in debug mode as follows:

```bash

git clone https://github.com/IntelPython/dpnp

cd dpnp

python scripts/build_locally.py

```

## Install Wheel Package via pip

Install DPNP

```cmd

python -m pip install --index-url https://software.repos.intel.com/python/pypi dpnp

```

Set path to Performance Libraries in case of using venv or system Python:

```cmd

export LD_LIBRARY_PATH=/lib

```

It is also required to set following environment variables:

```cmd

export OCL_ICD_FILENAMES_RESET=1

export OCL_ICD_FILENAMES=libintelocl.so

```

## Run test

```bash

pytest

# or

pytest tests/test_matmul.py -s -v

# or

python -m unittest tests/test_mixins.py

```

## Run numpy external test

```bash

. ./0.env.sh

python -m tests.third_party.numpy_ext

# or

python -m tests.third_party.numpy_ext core/tests/test_umath.py

# or

python -m tests.third_party.numpy_ext core/tests/test_umath.py::TestHypot::test_simple

```

### Building documentation:

```bash

Prerequisites:

$ conda install sphinx sphinx_rtd_theme

Building:

1. Install dpnp into your python environment

2. $ cd doc && make html

3. The documentation will be in doc/_build/html

```

## Packaging:

```bash

. ./0.env.sh

conda-build conda-recipe/

```

## Run benchmark:

```bash

cd benchmarks/

asv run --python=python --bench 

# example:

asv run --python=python --bench bench_elementwise

# or

asv run --python=python --bench .

# example:

asv run --python=python --bench Elementwise.time_square

# add --quick option to run every case once but looks like first execution has additional overheads and takes a lot of time (need to be investigated)

```

## Tests matrix:

| # |Name                                |OS   |distributive|interpreter|python used from|SYCL queue manager|build commands set                                                                                                                              |forced environment                                                                                                       |

|---|------------------------------------|-----|------------|-----------|:--------------:|:----------------:|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|

|1  |Ubuntu 20.04 Python37               |Linux|Ubuntu 20.04|Python 3.7 |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace pytest                                 |cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis                                                 |

|2  |Ubuntu 20.04 Python38               |Linux|Ubuntu 20.04|Python 3.8 |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace pytest                                 |cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis                                                 |

|3  |Ubuntu 20.04 Python39               |Linux|Ubuntu 20.04|Python 3.9 |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace pytest                                 |cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis                                                 |

|4  |Ubuntu 20.04 External Tests Python37|Linux|Ubuntu 20.04|Python 3.7 |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace python -m tests_external.numpy.runtests|cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis                                                 |

|5  |Ubuntu 20.04 External Tests Python38|Linux|Ubuntu 20.04|Python 3.8 |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace python -m tests_external.numpy.runtests|cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis                                                 |

|6  |Ubuntu 20.04 External Tests Python39|Linux|Ubuntu 20.04|Python 3.9 |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace python -m tests_external.numpy.runtests|cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis                                                 |

|7  |Code style                          |Linux|Ubuntu 20.04|Python 3.8 |  IntelOneAPI   |      local       |python ./setup.py style                                                                                                                         |cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis, conda-verify, pycodestyle, autopep8, black     |

|8  |Valgrind                            |Linux|Ubuntu 20.04|           |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace                                        |cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis                                                 |

|9  |Code coverage                       |Linux|Ubuntu 20.04|Python 3.8 |  IntelOneAPI   |      local       |export DPNP_DEBUG=1 python setup.py clean python setup.py build_clib python setup.py build_ext --inplace                                        |cmake-3.19.2, valgrind, pytest-valgrind, conda-build, pytest, hypothesis, conda-verify, pycodestyle, autopep8, pytest-cov|