Skip to content

Commit 2420ede

Browse files
committed
Updated developement guides
1 parent 1b2a178 commit 2420ede

File tree

5 files changed

+33
-12
lines changed

5 files changed

+33
-12
lines changed

doc/dpctl.rst

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1-
DPCtl Usage
2-
===========
1+
.. _dptcl:
2+
.. include:: ./ext_links.txt
33

4-
`DPCtl <https://github.com/IntelPython/dpctl>`_ provides API to manage
5-
specific SYCL resources for SYCL-based Python packages. DPNP uses DPCtl as
6-
a global SYCL queue manager. Below code illustrates simple usage of DPNP
7-
in combination with dpCtl.
4+
Interplay with the Data Parallel Control Library
5+
===============================================
6+
7+
`Data Parallel Control Library`_ provides API to manage specific
8+
`SYCL*`_ resources for SYCL-based Python packages.
9+
10+
An example below demonstrates how the Data Parallel Extension for NumPy* can be
11+
easily combined with the device management interface provided by dpctl package.
12+
13+
Literally, the SYCL* queue manager interface from the dpctl package allows
14+
to set an input queue as the currently usable queue inside the context
15+
manager's scope. This way an array creation function from the dpnp package
16+
which is defined inside the context will allocate the data using that queue.
817

918
.. code-block:: python
1019
:linenos:
@@ -16,10 +25,11 @@ in combination with dpCtl.
1625
x = np.array([1, 2, 3])
1726
s = np.sum(x)
1827
19-
For more information please refer to `DPCtl's documentation <https://intelpython.github.io/dpctl>`_.
28+
For more information please refer to `Data Parallel Control Library`_
29+
documentation.
2030

2131
Example
22-
~~~~~~~
32+
-------
2333
.. literalinclude:: ../examples/example10.py
2434
:linenos:
2535
:language: python

doc/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,10 @@ Data Parallel Extension for NumPy*
1212
overview
1313
quick_start_guide
1414
reference/index
15+
16+
.. toctree::
17+
:maxdepth: 1
18+
:caption: Development information
19+
1520
dpnp_backend_api
1621
dpctl

doc/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _overview
1+
.. _overview:
22
.. include:: ./ext_links.txt
33

44
Overview

doc/quick_start_guide.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ Install Package from Anaconda
4343
It is recommended to use conda packages from the ``anaconda.org/intel``
4444
channel. You will need one of the commands below:
4545

46-
* Conda: ``conda install numba-dpex``
46+
* Conda: ``conda install dpnp``
4747

48-
* Pip: ``pip install numba-dpex``
48+
* Pip: ``pip install dpnp``
4949

5050
These commands install dpnp package along with its dependencies, including
5151
``dpctl`` package with `Data Parallel Control Library`_ and all required
@@ -111,6 +111,12 @@ To build and install the package on Windows OS, run:
111111
112112
python setup.py install -- -G Ninja -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icx
113113
114+
Alternatively, to develop on Linux OS, you can use the driver script:
115+
116+
.. code-block:: bash
117+
118+
python scripts/build_locally.py
119+
114120
115121
Testing
116122
=======

doc/reference/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
API Reference
55
*************
66

7-
This is the official DPNP API reference.
7+
API reference of the Data Parallel Extension for NumPy*
88

99
----
1010

0 commit comments

Comments
 (0)