Skip to content

Latest commit

 

History

History
192 lines (148 loc) · 8.59 KB

README.md

File metadata and controls

192 lines (148 loc) · 8.59 KB

Code style: black Coverage Status pre-commit Join the chat at https://matrix.to/#/#Data-Parallel-Python_community:gitter.im Coverity Scan Build Status OpenSSF Scorecard oneAPI logo



Data Parallel Extension for Numba* (numba-dpex) is an open-source standalone extension for the Numba Python JIT compiler. Numba-dpex provides a SYCL*-like API for kernel programming Python. SYCL* is an open standard developed by the Unified Acceleration Foundation as a vendor-agnostic way of programming different types of data-parallel hardware such as multi-core CPUs, GPUs, and FPGAs. Numba-dpex's kernel-programming API brings the same programming model and a similar API to Python. The API allows expressing portable data-parallel kernels in Python and then JIT compiling them for different hardware targets. JIT compilation is supported for hardware that use the SPIR-V intermediate representation format that includes OpenCL CPU (Intel, AMD) devices, OpenCL GPU (Intel integrated and discrete GPUs) devices, and oneAPI Level Zero GPU (Intel integrated and discrete GPUs) devices.

The kernel programming API does not yet support every SYCL* feature. Refer to the SYCL* and numba-dpex feature comparison page to get a summary of supported features. Numba-dpex only implements SYCL*'s kernel programming API, all SYCL runtime Python bindings are provided by the dpctl package.

Along with the kernel programming API, numba-dpex extends Numba's auto-parallelizer to bring device offload capabilities to prange loops and NumPy-like vector expressions. The offload functionality is supported via the NumPy drop-in replacement library: dpnp. Note that dpnp and NumPy-based expressions can be used together in the same function, with dpnp expressions getting offloaded by numba-dpex and NumPy expressions getting parallelized by Numba.

Refer the documentation and examples to learn more.

Getting Started

Numba-dpex is part of the Intel® Distribution of Python (IDP) and Intel® oneAPI AIKit, and can be installed along with oneAPI. Additionally, we support installing it from Anaconda cloud. Please refer the instructions on our documentation page for more details.

Once the package is installed, a good starting point is to run the examples in the numba_dpex/examples directory. The test suite may also be invoked as follows:

python -m pytest --pyargs numba_dpex.tests

Conda

To install numba_dpex from the Intel(R) channel on Anaconda cloud, use the following command:

conda install numba-dpex -c intel -c conda-forge

Pip

The numba_dpex can be installed using pip obtaining wheel packages either from PyPi or from Intel(R) channel on Anaconda. To install numba_dpex wheel package from Intel(R) channel on Anaconda, run the following command:

python -m pip install --index-url https://pypi.anaconda.org/intel/simple numba-dpex

Contributing

Please create an issue for feature requests and bug reports. You can also use the GitHub Discussions feature for general questions.

If you want to chat with the developers, join the #Data-Parallel-Python_community room on Gitter.im.

Also refer our CONTRIBUTING page.

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the Angular change log.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any.

Samples: (even more samples)

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Scope

The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.

The following is the list of supported scopes:

  • animations
  • common
  • compiler
  • compiler-cli
  • core
  • elements
  • forms
  • http
  • language-service
  • platform-browser
  • platform-browser-dynamic
  • platform-server
  • platform-webworker
  • platform-webworker-dynamic
  • router
  • service-worker
  • upgrade

There are currently a few exceptions to the "use package name" rule:

  • packaging: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
  • changelog: used for updating the release notes in CHANGELOG.md
  • aio: used for docs-app (angular.io) related changes within the /aio directory of the repo
  • none/empty string: useful for style, test and refactor changes that are done across all packages (e.g. style: add missing semicolons)

Subject

The subject contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this [document][commit-message-format].