Docs for pull request 2071

Author: github-actions[doc-deploy-bot]

pulls/2071/_modules/dpctl.html

@@ -0,0 +1,16 @@
+.. _dpctl_constants:
+
+Constants
+=========
+
+The following constants are defined in :py:mod:`dpctl`:
+
+.. currentmodule:: dpctl
+
+.. autodata:: device_type
+
+.. autodata:: backend_type
+
+.. autodata:: event_status_type
+
+.. autodata:: global_mem_cache_type

pulls/2071/_modules/dpctl/_device_selection.html

@@ -0,0 +1,34 @@
+.. rubric:: Use :meth:`usm_ndarray.to_device` to migrate array to different device
+
+.. code-block:: python
+    :caption: Migrate array to a different device
+
+        from dpctl import tensor
+
+        a = tensor.zeros(100, device="cpu")
+        b = a.to_device("gpu")
+
+
+.. rubric:: Use :meth:`usm_ndarray.device` to specify placement of new array
+
+.. code-block:: python
+    :caption: Create a USM-device empty array on the same device as another array
+
+        from dpctl import tensor
+
+        d = tensor.eye(100)
+        u = tensor.full(d.shape, fill_value=0.5, usm_type="device", device=d.device)
+
+.. rubric:: Use :meth:`usm_ndarray.mT` to transpose matrices in a array thought of as a stack of matrices
+
+.. code-block:: python
+    :caption: Transpose an array
+
+        from dpctl import tensor
+
+        # create stack of matrices
+        proto = tensor.asarray([[2, 1], [3, 4]])
+        ar = tensor.tile(proto, (5, 10, 10))
+
+        # transpose each matrix in the stack
+        arT = ar.mT

pulls/2071/_modules/dpctl/_sycl_timer.html

@@ -0,0 +1,54 @@
+.. _filter_selector_string:
+
+Filter Selector String
+======================
+
+Filter selector string is a way to refer to unpartitioned SYCL devices
+proposed in :oneapi_filter_selection:`sycl_ext_oneapi_filter_selector <>`
+extension to SYCL standard.
+
+This document captures aspects of the referenced document relevant
+to :mod:`dpctl`.
+
+A filter selector string defines one or more filters, which must be
+separated using ``","`` character. A filter is specified as a
+triple of the form:
+
+.. code-block:: text
+
+    Backend:DeviceType:RelativeDeviceNumber
+
+Every element of the triple is optional, but a filter must contain at
+least one component.
+
+``Backend`` specifies the desired backend of targeted devices, while
+``DeviceType`` specifies the type of targeted devices.
+``RelativeDeviceNumber`` refers to the number of the device that matches
+any other given requirements, starting from `0` to marking the
+"first device that matches the requirements".
+
+Attempting to use a non-conforming string in places where filter selector
+string is expected will raise an exception.
+
+Supported values for ``Backend`` are:
+
+.. list-table::
+
+    * - cuda
+      - opencl
+      - level_zero
+      - hip
+
+Supported values for ``DeviceType`` are:
+
+.. list-table::
+
+    * - accelerator
+      - cpu
+      - gpu
+
+Filter selector strings can be used as arguments to constructors of
+:py:class:`dpctl.SyclDevice`, :py:class:`dpctl.SyclContext`,
+:py:class:`dpctl.SyclPlatform`, :py:class:`dpctl.SyclQueue`,
+or :py:class:`dpctl.tensor.Device` classes, as well as values of
+``device`` keyword in :ref:`array creation functions <dpctl_tensor_creation_functions>`.

pulls/2071/_modules/dpctl/enum_types.html

@@ -0,0 +1,22 @@
+.. _Flags_class:
+
+``Flags`` class
+===================
+
+.. autoclass:: dpctl.tensor._flags.Flags
+    :members:
+
+    Note that dictionary-like access to some members is permitted:
+
+        "C", "C_CONTIGUOUS":
+            Equivalent to ``c_contiguous``
+        "F", "F_CONTIGUOUS":
+            Equivalent to ``f_contiguous``
+        "W", "WRITABLE":
+            Equivalent to ``writable``
+        "FC":
+            Equivalent to ``fc``
+        "FNC":
+            Equivalent to ``fnc``
+        "FORC", "CONTIGUOUS":
+            Equivalent to ``forc`` and ``contiguous``

pulls/2071/_modules/dpctl/tensor/_array_api.html

@@ -0,0 +1,29 @@
+dpctl.SyclContext
+=================
+
+.. currentmodule:: dpctl
+
+.. autoclass:: SyclContext
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclContext.addressof_ref
+      ~SyclContext.get_devices
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclContext.device_count
+   
+   

pulls/2071/_modules/dpctl/tensor/_clip.html

@@ -0,0 +1,6 @@
+dpctl.SyclContextCreationError
+==============================
+
+.. currentmodule:: dpctl
+
+.. autoexception:: SyclContextCreationError

pulls/2071/_modules/dpctl/tensor/_copy_utils.html

@@ -0,0 +1,107 @@
+dpctl.SyclDevice
+================
+
+.. currentmodule:: dpctl
+
+.. autoclass:: SyclDevice
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclDevice.addressof_ref
+      ~SyclDevice.component_devices
+      ~SyclDevice.create_sub_devices
+      ~SyclDevice.get_device_id
+      ~SyclDevice.get_filter_string
+      ~SyclDevice.get_unpartitioned_parent_device
+      ~SyclDevice.print_device_info
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclDevice.backend
+      ~SyclDevice.composite_device
+      ~SyclDevice.default_selector_score
+      ~SyclDevice.device_type
+      ~SyclDevice.driver_version
+      ~SyclDevice.filter_string
+      ~SyclDevice.global_mem_cache_line_size
+      ~SyclDevice.global_mem_cache_size
+      ~SyclDevice.global_mem_cache_type
+      ~SyclDevice.global_mem_size
+      ~SyclDevice.has_aspect_accelerator
+      ~SyclDevice.has_aspect_atomic64
+      ~SyclDevice.has_aspect_cpu
+      ~SyclDevice.has_aspect_custom
+      ~SyclDevice.has_aspect_emulated
+      ~SyclDevice.has_aspect_fp16
+      ~SyclDevice.has_aspect_fp64
+      ~SyclDevice.has_aspect_gpu
+      ~SyclDevice.has_aspect_host_debuggable
+      ~SyclDevice.has_aspect_image
+      ~SyclDevice.has_aspect_is_component
+      ~SyclDevice.has_aspect_is_composite
+      ~SyclDevice.has_aspect_online_compiler
+      ~SyclDevice.has_aspect_online_linker
+      ~SyclDevice.has_aspect_queue_profiling
+      ~SyclDevice.has_aspect_usm_atomic_host_allocations
+      ~SyclDevice.has_aspect_usm_atomic_shared_allocations
+      ~SyclDevice.has_aspect_usm_device_allocations
+      ~SyclDevice.has_aspect_usm_host_allocations
+      ~SyclDevice.has_aspect_usm_shared_allocations
+      ~SyclDevice.has_aspect_usm_system_allocations
+      ~SyclDevice.image_2d_max_height
+      ~SyclDevice.image_2d_max_width
+      ~SyclDevice.image_3d_max_depth
+      ~SyclDevice.image_3d_max_height
+      ~SyclDevice.image_3d_max_width
+      ~SyclDevice.is_accelerator
+      ~SyclDevice.is_cpu
+      ~SyclDevice.is_gpu
+      ~SyclDevice.local_mem_size
+      ~SyclDevice.max_clock_frequency
+      ~SyclDevice.max_compute_units
+      ~SyclDevice.max_mem_alloc_size
+      ~SyclDevice.max_num_sub_groups
+      ~SyclDevice.max_read_image_args
+      ~SyclDevice.max_work_group_size
+      ~SyclDevice.max_work_item_dims
+      ~SyclDevice.max_work_item_sizes
+      ~SyclDevice.max_work_item_sizes1d
+      ~SyclDevice.max_work_item_sizes2d
+      ~SyclDevice.max_work_item_sizes3d
+      ~SyclDevice.max_write_image_args
+      ~SyclDevice.name
+      ~SyclDevice.native_vector_width_char
+      ~SyclDevice.native_vector_width_double
+      ~SyclDevice.native_vector_width_float
+      ~SyclDevice.native_vector_width_half
+      ~SyclDevice.native_vector_width_int
+      ~SyclDevice.native_vector_width_long
+      ~SyclDevice.native_vector_width_short
+      ~SyclDevice.parent_device
+      ~SyclDevice.partition_max_sub_devices
+      ~SyclDevice.preferred_vector_width_char
+      ~SyclDevice.preferred_vector_width_double
+      ~SyclDevice.preferred_vector_width_float
+      ~SyclDevice.preferred_vector_width_half
+      ~SyclDevice.preferred_vector_width_int
+      ~SyclDevice.preferred_vector_width_long
+      ~SyclDevice.preferred_vector_width_short
+      ~SyclDevice.profiling_timer_resolution
+      ~SyclDevice.sub_group_independent_forward_progress
+      ~SyclDevice.sub_group_sizes
+      ~SyclDevice.sycl_platform
+      ~SyclDevice.vendor
+   
+   

pulls/2071/_modules/dpctl/tensor/_ctors.html

@@ -0,0 +1,6 @@
+dpctl.SyclDeviceCreationError
+=============================
+
+.. currentmodule:: dpctl
+
+.. autoexception:: SyclDeviceCreationError

pulls/2071/_modules/dpctl/tensor/_device.html

@@ -0,0 +1,35 @@
+dpctl.SyclEvent
+===============
+
+.. currentmodule:: dpctl
+
+.. autoclass:: SyclEvent
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclEvent.addressof_ref
+      ~SyclEvent.get_wait_list
+      ~SyclEvent.wait
+      ~SyclEvent.wait_for
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclEvent.backend
+      ~SyclEvent.execution_status
+      ~SyclEvent.profiling_info_end
+      ~SyclEvent.profiling_info_start
+      ~SyclEvent.profiling_info_submit
+   
+   

pulls/2071/_modules/dpctl/tensor/_indexing_functions.html

@@ -0,0 +1,34 @@
+dpctl.SyclPlatform
+==================
+
+.. currentmodule:: dpctl
+
+.. autoclass:: SyclPlatform
+   
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclPlatform.get_composite_devices
+      ~SyclPlatform.get_devices
+      ~SyclPlatform.print_platform_info
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: generated
+   
+      ~SyclPlatform.backend
+      ~SyclPlatform.default_context
+      ~SyclPlatform.name
+      ~SyclPlatform.vendor
+      ~SyclPlatform.version
+   
+