Merge pull request #1473 from IntelPython/pin/sphinx-autoapi

Pin sphinx-autoapi==3.0.0 92e918c

dev/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d54ad7d60608ed4aeb4598ac5fd1c665
+config: 5ae8a096804977539812c09e086c1b6d
 tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_sources/autoapi/numba_dpex/core/boxing/ranges/index.rst.txt

@@ -0,0 +1,59 @@
+
+
+:orphan:
+
+numba_dpex.core.boxing.ranges
+=============================
+
+.. py:module:: numba_dpex.core.boxing.ranges
+
+
+
+
+Overview
+--------
+
+.. list-table:: Function
+   :header-rows: 0
+   :widths: auto
+   :class: summarytable
+
+   * - :py:obj:`unbox_range <numba_dpex.core.boxing.ranges.unbox_range>`\ (typ, obj, c)
+     - Converts a Python Range object to numba-dpex's native struct representation
+   * - :py:obj:`unbox_ndrange <numba_dpex.core.boxing.ranges.unbox_ndrange>`\ (typ, obj, c)
+     - Converts a Python Range object to numba-dpex's native struct representation
+   * - :py:obj:`box_range <numba_dpex.core.boxing.ranges.box_range>`\ (typ, val, c)
+     - Convert a native range structure to a Range object.
+   * - :py:obj:`box_ndrange <numba_dpex.core.boxing.ranges.box_ndrange>`\ (typ, val, c)
+     - Convert a native range structure to a Range object.
+
+
+
+
+Functions
+---------
+.. py:function:: unbox_range(typ, obj, c)
+
+   Converts a Python Range object to numba-dpex's native struct representation
+   for RangeType.
+
+
+.. py:function:: unbox_ndrange(typ, obj, c)
+
+   Converts a Python Range object to numba-dpex's native struct representation
+   for NdRangeType.
+
+
+.. py:function:: box_range(typ, val, c)
+
+   Convert a native range structure to a Range object.
+
+
+.. py:function:: box_ndrange(typ, val, c)
+
+   Convert a native range structure to a Range object.
+
+
+
+
+

dev/_sources/autoapi/numba_dpex/core/boxing/usm_ndarray/index.rst.txt

@@ -0,0 +1,60 @@
+
+
+:orphan:
+
+numba_dpex.core.boxing.usm_ndarray
+==================================
+
+.. py:module:: numba_dpex.core.boxing.usm_ndarray
+
+
+
+
+Overview
+--------
+
+.. list-table:: Function
+   :header-rows: 0
+   :widths: auto
+   :class: summarytable
+
+   * - :py:obj:`unbox_dpnp_nd_array <numba_dpex.core.boxing.usm_ndarray.unbox_dpnp_nd_array>`\ (typ, obj, c)
+     - Converts a dpctl.tensor.usm_ndarray/dpnp.ndarray object to a Numba-dpex
+   * - :py:obj:`box_array <numba_dpex.core.boxing.usm_ndarray.box_array>`\ (typ, val, c)
+     - Boxes a NativeValue representation of USMNdArray/DpnpNdArray type into a
+
+
+
+
+Functions
+---------
+.. py:function:: unbox_dpnp_nd_array(typ, obj, c)
+
+   Converts a dpctl.tensor.usm_ndarray/dpnp.ndarray object to a Numba-dpex
+   internal array structure.
+
+   :param typ: The Numba type of the PyObject
+   :param obj: The actual PyObject to be unboxed
+   :param c: The unboxing context
+
+   Returns: A NativeValue object representing an unboxed
+       dpctl.tensor.usm_ndarray/dpnp.ndarray
+
+
+.. py:function:: box_array(typ, val, c)
+
+   Boxes a NativeValue representation of USMNdArray/DpnpNdArray type into a
+   dpctl.tensor.usm_ndarray/dpnp.ndarray PyObject
+
+   :param typ: The representation of the USMNdArray/DpnpNdArray type.
+   :param val: A native representation of a Numba USMNdArray/DpnpNdArray type
+               object.
+   :param c: The boxing context.
+
+   Returns: A Pyobject for a dpctl.tensor.usm_ndarray/dpnp.ndarray boxed from
+       the Numba-dpex native value.
+
+
+
+
+

dev/_sources/autoapi/numba_dpex/core/config/index.rst.txt

@@ -0,0 +1,99 @@
+
+numba_dpex.core.config
+======================
+
+.. py:module:: numba_dpex.core.config
+
+.. autoapi-nested-parse::
+
+   The config options are meant to provide extra information and tweak optimization
+   configurations to help debug code generation issues.
+
+   There are two ways of setting these config options:
+
+   - Config options can be directly set programmatically, *e.g.*,
+
+       .. code-block:: python
+
+           from numba_dpex.core.config import DUMP_KERNEL_LLVM
+
+           DUMP_KERNEL_LLVM = 1
+
+   - The options can also be set globally using environment flags. The name of the
+     environment variable for every config option is annotated next to its
+     definition.
+
+       .. code-block:: bash
+
+           export NUMBA_DPEX_DUMP_KERNEL_LLVM = 1
+
+
+
+
+
+
+
+
+Attributes
+----------
+.. py:data:: SAVE_IR_FILES
+   :type: Annotated[int, Save the IR files (LLVM and SPIRV-V) generated for each kernel to current directory, default = 0, ENVIRONMENT FLAG: NUMBA_DPEX_SAVE_IR_FILES]
+
+
+
+.. py:data:: OFFLOAD_DIAGNOSTICS
+   :type: Annotated[int, Print diagnostic information for automatic offloading of parfor nodes to kernels, default = 0, ENVIRONMENT FLAG: NUMBA_DPEX_OFFLOAD_DIAGNOSTICS]
+
+
+
+.. py:data:: DEBUG
+   :type: Annotated[int, Generates extra debug prints when set to a non-zero value, default = 0, ENVIRONMENT FLAG: NUMBA_DPEX_DEBUG]
+
+
+
+.. py:data:: DEBUGINFO_DEFAULT
+   :type: Annotated[int, Compiles in the debug mode generating debug symbols in the compiler IR. It is a global way of setting the "debug" keyword for all numba_dpex.kernel and numba_dpex.device_func decorators used in a program., default = 0, ENVIRONMENT FLAG: NUMBA_DPEX_DEBUGINFO]
+
+
+
+.. py:data:: DUMP_KERNEL_LLVM
+   :type: Annotated[int, Writes the optimized LLVM IR generated for a numba_dpex.kernel decorated function to current directory, default = 0, ENVIRONMENT FLAG: NUMBA_DPEX_DUMP_KERNEL_LLVM]
+
+
+
+.. py:data:: DUMP_KERNEL_LAUNCHER
+   :type: Annotated[int, Writes the optimized LLVM IR generated for every numba_dpex.call_kernel function to current directory, default = 0, ENVIRONMENT FLAG: NUMBA_DPEX_DUMP_KERNEL_LAUNCHER]
+
+
+
+.. py:data:: DEBUG_KERNEL_LAUNCHER
+   :type: Annotated[int, Enables debug printf messages inside the compiled module generated for a numba_dpex.call_kernel function.default = 0, ENVIRONMENT FLAG: NUMBA_DPEX_DEBUG_KERNEL_LAUNCHER]
+
+
+
+.. py:data:: BUILD_KERNEL_OPTIONS
+   :type: Annotated[str, Can use used to pass extra flags to the device driver compiler during kernel compilation. For available OpenCL options refer https://intel.github.io/llvm-docs/clang/ClangCommandLineReference.html#opencl-options, default = "", ENVIRONMENT FLAG: NUMBA_DPEX_BUILD_KERNEL_OPTIONS]
+
+
+
+.. py:data:: TESTING_SKIP_NO_DEBUGGING
+
+   
+
+.. py:data:: TESTING_LOG_DEBUGGING
+   :type: Annotated[int, Generates extra logs when using gdb to debug a kernel, defaults = 0, ENVIRONMENT_FLAG: NUMBA_DPEX_TESTING_LOG_DEBUGGING]
+
+
+
+.. py:data:: DPEX_OPT
+   :type: Annotated[int, Sets the optimization level globally for every function compiled by numba-dpex, default = 2, ENVIRONMENT_FLAG: NUMBA_DPEX_OPT]
+
+
+
+.. py:data:: INLINE_THRESHOLD
+   :type: Annotated[int, Sets the inlining-threshold level globally for every function compiled by numba-dpex. A higher value enables more aggressive inlining settings for the compiler. Note: Even if NUMBA_DPEX_INLINE_THRESHOLD is set to 0, many internal functions that are attributed "alwaysinline" will still get inlined., default = 2, ENVIRONMENT_FLAG: NUMBA_DPEX_INLINE_THRESHOLD]
+
+
+
+
+