From 3475c74ca0269cdd4e9199ce325668e510f0a5af Mon Sep 17 00:00:00 2001 From: Oleksandr Pavlyk Date: Wed, 17 Apr 2024 10:05:16 -0500 Subject: [PATCH 1/2] Spelling mistakes in dpctl module --- dpctl/_sycl_queue.pyx | 2 +- dpctl/memory/_memory.pyx | 6 +++--- dpctl/utils/__init__.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/dpctl/_sycl_queue.pyx b/dpctl/_sycl_queue.pyx index 109eaccc5a..e85e35c29a 100644 --- a/dpctl/_sycl_queue.pyx +++ b/dpctl/_sycl_queue.pyx @@ -903,7 +903,7 @@ cdef class SyclQueue(_SyclQueue): @property def sycl_device(self): """ - Returns :class:`.SyclDevice` targeted by this queuey. + Returns :class:`.SyclDevice` targeted by this queue. Returns: :class:`SyclDevice` diff --git a/dpctl/memory/_memory.pyx b/dpctl/memory/_memory.pyx index ebee7c4338..df5d360e2a 100644 --- a/dpctl/memory/_memory.pyx +++ b/dpctl/memory/_memory.pyx @@ -357,9 +357,9 @@ cdef class _Memory: * ``"data"`` (Tuple[int, bool]) unified address space pointer presented as Python integer - and a Boolean value of 'writeable' flag. If ``False`` the + and a Boolean value of 'writable' flag. If ``False`` the allocation is read-only. The return flag is always set to - writeable. + writable. * ``"shape"`` (Tuple[int]) Extent of array in bytes. Shape is always 1-tuple for this object. @@ -789,7 +789,7 @@ cdef class MemoryUSMHost(_Memory): queue (Optional[:class:`dpctl.SyclQueue`]): SYCL queue associated with return allocation instance. Allocation is made in host memory accessible - to all device in te SYCL context from the queue. + to all device in the SYCL context from the queue. Allocation is bound to SYCL context from the queue. If ``queue`` is ``None`` a cached default-constructed :class:`dpctl.SyclQueue` is diff --git a/dpctl/utils/__init__.py b/dpctl/utils/__init__.py index e4143c022a..f5e5797d0c 100644 --- a/dpctl/utils/__init__.py +++ b/dpctl/utils/__init__.py @@ -66,7 +66,7 @@ def intel_device_info(dev, /): Unsupported descriptors are omitted from the dictionary. Descriptors other than the PCI identifier are supported only - for :class:`.SyclDevices` with Leve-Zero backend. + for :class:`.SyclDevices` with Level-Zero backend. """ if not isinstance(dev, SyclDevice): raise TypeError(f"Expected dpctl.SyclDevice, got {type(dev)}") From f603fb1b148a0a7e93c75e22df3f5a2a7b42e18d Mon Sep 17 00:00:00 2001 From: Oleksandr Pavlyk Date: Wed, 17 Apr 2024 10:06:08 -0500 Subject: [PATCH 2/2] Spelling mistakes in libsyclinterface --- .../include/syclinterface/Support/MemOwnershipAttrs.h | 2 +- libsyclinterface/include/syclinterface/dpctl_service.h | 2 +- .../syclinterface/dpctl_sycl_platform_interface.h | 2 +- .../syclinterface/dpctl_sycl_platform_manager.h | 6 +++--- .../include/syclinterface/dpctl_sycl_queue_interface.h | 10 +++++----- .../include/syclinterface/dpctl_sycl_queue_manager.h | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/libsyclinterface/include/syclinterface/Support/MemOwnershipAttrs.h b/libsyclinterface/include/syclinterface/Support/MemOwnershipAttrs.h index bf78857e78..cf7b3b2d3b 100644 --- a/libsyclinterface/include/syclinterface/Support/MemOwnershipAttrs.h +++ b/libsyclinterface/include/syclinterface/Support/MemOwnershipAttrs.h @@ -55,7 +55,7 @@ * the ownership of the object and the user must not use the object as an * argument to another function. * - * The __dpctl_take attribute mens that the function destroys it before the + * The __dpctl_take attribute means that the function destroys it before the * function returns, and the caller must not use the object again in any other * function. If the pointer annotated with __dpctl_take is NULL then it is * treated as an error, since it may prevent the normal behavior of the diff --git a/libsyclinterface/include/syclinterface/dpctl_service.h b/libsyclinterface/include/syclinterface/dpctl_service.h index 6d66ef5c10..6b80747db5 100644 --- a/libsyclinterface/include/syclinterface/dpctl_service.h +++ b/libsyclinterface/include/syclinterface/dpctl_service.h @@ -54,7 +54,7 @@ DPCTL_API void DPCTLService_InitLogger(const char *app_name, const char *log_dir); /*! - * @brief Finilize logger if enabled, no-op otherwise. + * @brief Finalize logger if enabled, no-op otherwise. * * @ingroup Service */ diff --git a/libsyclinterface/include/syclinterface/dpctl_sycl_platform_interface.h b/libsyclinterface/include/syclinterface/dpctl_sycl_platform_interface.h index 56fe56d343..8d95a45cf0 100644 --- a/libsyclinterface/include/syclinterface/dpctl_sycl_platform_interface.h +++ b/libsyclinterface/include/syclinterface/dpctl_sycl_platform_interface.h @@ -124,7 +124,7 @@ DPCTLPlatform_GetName(__dpctl_keep const DPCTLSyclPlatformRef PRef); * @brief Returns a C string corresponding to the vendor providing the platform. * * @param PRef Opaque pointer to a sycl::platform - * @return A C string containing the name of the vendor provifing the + * @return A C string containing the name of the vendor providing the * platform. * @ingroup PlatformInterface */ diff --git a/libsyclinterface/include/syclinterface/dpctl_sycl_platform_manager.h b/libsyclinterface/include/syclinterface/dpctl_sycl_platform_manager.h index 141fff2ce0..052ed9eec1 100644 --- a/libsyclinterface/include/syclinterface/dpctl_sycl_platform_manager.h +++ b/libsyclinterface/include/syclinterface/dpctl_sycl_platform_manager.h @@ -44,7 +44,7 @@ DPCTL_C_EXTERN_C_BEGIN DPCTL_DECLARE_VECTOR(Platform) /*! - * @brief Prints out information about the sycl::platform argument. + * @brief Prints out information about the ``sycl::platform`` argument. * * The helper function is used to print metadata about a given platform. The * amount of information printed out is controlled by the verbosity level. @@ -57,7 +57,7 @@ DPCTL_DECLARE_VECTOR(Platform) * platform. * * @param PRef A #DPCTLSyclPlatformRef opaque pointer. - * @param verbosity Verbosilty level to control how much information is + * @param verbosity Verbosity level to control how much information is * printed out. */ DPCTL_API @@ -78,7 +78,7 @@ void DPCTLPlatformMgr_PrintInfo(__dpctl_keep const DPCTLSyclPlatformRef PRef, * platform. * * @param PRef A #DPCTLSyclPlatformRef opaque pointer. - * @param verbosity Verbosilty level to control how much information is + * @param verbosity Verbosity level to control how much information is * printed out. * @return A formatted C string capturing the information about the * sycl::platform argument. diff --git a/libsyclinterface/include/syclinterface/dpctl_sycl_queue_interface.h b/libsyclinterface/include/syclinterface/dpctl_sycl_queue_interface.h index 2d876a97cf..a0d283c0f8 100644 --- a/libsyclinterface/include/syclinterface/dpctl_sycl_queue_interface.h +++ b/libsyclinterface/include/syclinterface/dpctl_sycl_queue_interface.h @@ -41,7 +41,7 @@ DPCTL_C_EXTERN_C_BEGIN /*! * @brief A wrapper for sycl::queue constructor to construct a new queue from - * the provided context, device, async handler and propertis bit flags. + * the provided context, device, async handler and properties bit flags. * * @param CRef An opaque pointer to a sycl::context. * @param DRef An opaque pointer to a sycl::device @@ -67,7 +67,7 @@ DPCTLQueue_Create(__dpctl_keep const DPCTLSyclContextRef CRef, * @brief Constructs a ``sycl::queue`` object of the specified SYCL device. * * Constructs a new SYCL queue for the specified SYCL device. The - * behaviour of this function differs from the following queue constructor: + * behavior of this function differs from the following queue constructor: * * @code * queue( @@ -81,9 +81,9 @@ DPCTLQueue_Create(__dpctl_keep const DPCTLSyclContextRef CRef, * context for the device and instead look to reuse a previously cached * SYCL context for the device (refer dpctl_sycl_device_manager.cpp). * DPCTL caches contexts only for root devices and for all custom devices the - * function begaves the same way as the SYCL constructor. + * function behaves the same way as the SYCL constructor. * - * @param dRef An opaque pointer to a ``sycl::device``. + * @param DRef An opaque pointer to a ``sycl::device``. * @param handler A callback function that will be invoked by the * async_handler used during queue creation. Can be * NULL if no async_handler is needed. @@ -98,7 +98,7 @@ DPCTLQueue_Create(__dpctl_keep const DPCTLSyclContextRef CRef, */ DPCTL_API __dpctl_give DPCTLSyclQueueRef -DPCTLQueue_CreateForDevice(__dpctl_keep const DPCTLSyclDeviceRef dRef, +DPCTLQueue_CreateForDevice(__dpctl_keep const DPCTLSyclDeviceRef DRef, error_handler_callback *handler, int properties); diff --git a/libsyclinterface/include/syclinterface/dpctl_sycl_queue_manager.h b/libsyclinterface/include/syclinterface/dpctl_sycl_queue_manager.h index 3aefb01530..43a1e47d67 100644 --- a/libsyclinterface/include/syclinterface/dpctl_sycl_queue_manager.h +++ b/libsyclinterface/include/syclinterface/dpctl_sycl_queue_manager.h @@ -95,7 +95,7 @@ DPCTL_API void DPCTLQueueMgr_SetGlobalQueue(__dpctl_keep const DPCTLSyclQueueRef QRef); /*! - * @brief Pushes the passed in sycl::queue object to the queue manager's + * @brief Pushes the passed in ``sycl::queue`` object to the queue manager's * internal stack of queues and makes the queue the current queue. * * The queue manager maintains a thread-local stack of sycl::queue @@ -104,7 +104,7 @@ void DPCTLQueueMgr_SetGlobalQueue(__dpctl_keep const DPCTLSyclQueueRef QRef); * current queue is the queue returned by the DPCTLQueueMgr_GetCurrentQueue() * function. * - * @param QRef An opaque reference to a syc::queue. + * @param QRef An opaque reference to a ``sycl::queue``. * @ingroup QueueManager */ DPCTL_API