Skip to content

Commit

Permalink
Update doc (#378)
Browse files Browse the repository at this point in the history
* Update doc

* Update dpnp version

* Update name
  • Loading branch information
reazulhoque authored May 21, 2021
1 parent d6130ef commit 307d7ef
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
16 changes: 8 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to numba-dppy's documentation!
Welcome to Numba-dppy's documentation!
======================================

``numba-dppy`` is a standalone extension to the `Numba
`Numba-dppy <https://github.com/IntelPython/numba-dppy>`_ is a standalone extension to the `Numba
<https://numba.pydata.org/>`_ JIT compiler that adds `SYCL
<https://www.khronos.org/sycl/>`_ programming capabilities to Numba.
``numba-dppy`` uses `dpctl <https://github.com/IntelPython/dpctl>`_ to support
Numba-dppy uses `dpctl <https://github.com/IntelPython/dpctl>`_ to support
SYCL features and currently Intel's `DPC++ <https://github.com/intel/llvm/blob/sycl/sycl/doc/GetStartedGuide.md>`_ is the only SYCL runtime supported by
``numba-dppy``.
Numba-dppy.

There are two ways to program SYCL devices using ``numba-dppy``:
There are two ways to program SYCL devices using Numba-dppy:

- An explicit kernel programming mode.

Expand Down Expand Up @@ -75,19 +75,19 @@ There are two ways to program SYCL devices using ``numba-dppy``:
About
=====

``numba-dppy`` is developed by Intel and is part of the `Intel Distribution for
Numba-dppy is developed by Intel and is part of the `Intel Distribution for
Python <https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/distribution-for-python.html>`_.

Contributing
============

Refer the `contributing guide <https://github.com/IntelPython/numba-dppy/blob/main/CONTRIBUTING>`_
for information on coding style and standards used in ``numba-dppy``.
for information on coding style and standards used in Numba-dppy.

License
=======

numba-dppy is Licensed under Apache License 2.0 that can be found in
Numba-dppy is Licensed under Apache License 2.0 that can be found in
`LICENSE <https://github.com/IntelPython/numba-dppy/blob/main/LICENSE>`_.
All usage and contributions to the project are subject to the terms and
conditions of this license.
12 changes: 6 additions & 6 deletions docs/user_guides/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Getting Started
Installation
------------

``numba-dppy`` depends on following components:
Numba-dppy depends on following components:

* numba 0.52.* (`Intel Python Numba`_)
* dpctl 0.7.* (`Intel Python dpctl`_)
* dpnp >=0.5.1 (optional, `Intel Python DPNP`_)
* numba 0.53.* (`Intel Python Numba`_)
* dpctl 0.8.* (`Intel Python dpctl`_)
* dpnp >=0.6.* (optional, `Intel Python DPNP`_)
* `llvm-spirv`_ (SPIRV generation from LLVM IR)
* `llvmdev`_ (LLVM IR generation)
* `spirv-tools`_
Expand Down Expand Up @@ -105,10 +105,10 @@ To run the examples:
Limitations
-----------

Using ``numba-dppy`` requires `Intel Python Numba`_ as that version of Numba has
Using Numba-dppy requires `Intel Python Numba`_ as that version of Numba has
patches needed to recognize a ``dpctl.device_context`` scope and trigger
code-generation for a SYCL device. Work in underway to upstream all patches, so
that in future ``numba-dppy`` can work with upstream Numba.
that in future Numba-dppy can work with upstream Numba.

.. _`Intel Python Numba`: https://github.com/IntelPython/numba
.. _`Intel Python dpctl`: https://github.com/IntelPython/dpctl
Expand Down

0 comments on commit 307d7ef

Please sign in to comment.