Skip to content

Commit c489c7e

Browse files
committed
Add documentation for constants and DLDeviceType enums
1 parent 5ae872a commit c489c7e

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _dpctl_tensor_constants:
2+
3+
Constants
4+
========================
5+
6+
The following constants are defined in :py:mod:`dpctl.tensor`:
7+
8+
.. currentmodule:: dpctl.tensor
9+
10+
.. autodata:: DLDeviceType
11+
12+
.. data:: e
13+
14+
``float``:
15+
IEEE 754 floating-point representation of Euler's constant.
16+
17+
.. data:: inf
18+
19+
``float``:
20+
IEEE 754 floating-point representation of (positive) infinity.
21+
22+
.. data:: nan
23+
24+
``float``:
25+
IEEE 754 floating-point representation of Not a Number (NaN).
26+
27+
.. data:: newaxis
28+
29+
``NoneType``:
30+
Alias for ``None`` which is useful for indexing.
31+
32+
.. data:: pi
33+
34+
``float``:
35+
IEEE 754 floating-point representation of the mathematical constant π.
36+

docs/doc_sources/api_reference/dpctl/tensor.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ This module contains:
2929
* :ref:`sorting functions <dpctl_tensor_sorting_functions>`
3030
* :ref:`statistical functions <dpctl_tensor_statistical_functions>`
3131
* :ref:`utility functions <dpctl_tensor_utility_functions>`
32+
* :ref:`constants <dpctl_tensor_constants>`
3233

3334

3435
.. toctree::
@@ -48,3 +49,4 @@ This module contains:
4849
tensor.sorting_functions
4950
tensor.statistical_functions
5051
tensor.utility_functions
52+
tensor.constants

dpctl/tensor/_usmarray.pyx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1278,6 +1278,8 @@ cdef class usm_ndarray:
12781278
The tuple describes the non-partitioned device where the array has been allocated,
12791279
or the non-partitioned parent device of the allocation device.
12801280
1281+
See ``DLDeviceType`` for a list of devices supported by the DLPack protocol.
1282+
12811283
Raises:
12821284
DLPackCreationError:
12831285
when the ``device_id`` could not be determined.

0 commit comments

Comments
 (0)