Skip to content

Commit

Permalink
Updated developement guides
Browse files Browse the repository at this point in the history
  • Loading branch information
antonwolfy committed Jul 18, 2023
1 parent 1b2a178 commit f0fd782
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
21 changes: 14 additions & 7 deletions doc/dpctl.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
DPCtl Usage
===========
Cooperation with the `Data Parallel Control Library`_ interface
===============================================================

`DPCtl <https://github.com/IntelPython/dpctl>`_ provides API to manage
specific SYCL resources for SYCL-based Python packages. DPNP uses DPCtl as
a global SYCL queue manager. Below code illustrates simple usage of DPNP
in combination with dpCtl.
`Data Parallel Control Library`_ provides API to manage specific
`SYCL*`_ resources for SYCL-based Python packages.

An example below demonstrates how the Data Parallel Extension for NumPy* can be
easily combined with the device management interface provided by dpctl package.

Literally, the SYCL* queue manager interface from the dpctl package allows
to set an input queue as the currently usable queue inside the context
manager's scope. This way an array creation function from the dpnp package
which is defined inside the context will allocate the data using that queue.

.. code-block:: python
:linenos:
Expand All @@ -16,7 +22,8 @@ in combination with dpCtl.
x = np.array([1, 2, 3])
s = np.sum(x)
For more information please refer to `DPCtl's documentation <https://intelpython.github.io/dpctl>`_.
For more information please refer to `Data Parallel Control Library`_
documentation.

Example
~~~~~~~
Expand Down
5 changes: 5 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,10 @@ Data Parallel Extension for NumPy*
overview
quick_start_guide
reference/index

.. toctree::
:maxdepth: 2
:caption: Development information

dpnp_backend_api
dpctl
2 changes: 1 addition & 1 deletion doc/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
API Reference
*************

This is the official DPNP API reference.
API reference of the Data Parallel Extension for NumPy*

----

Expand Down

0 comments on commit f0fd782

Please sign in to comment.