From fc911c777c7570ceefb8f24919fc4ce51cbe1b74 Mon Sep 17 00:00:00 2001 From: samaid Date: Fri, 5 Nov 2021 12:18:15 -0500 Subject: [PATCH] Update intro.rst Made Intro section less SYCL centric. Main goal is to avoid references to SYCL as much as possible. Otherwise we will end up teaching Python users DPC++. I understand that references to SYCL in dpctl are unavoidable but still I truly believe we can educate general Python users how to use XPU without the need to read SYCL specs --- docs/docfiles/intro.rst | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/docs/docfiles/intro.rst b/docs/docfiles/intro.rst index 115749b3da..55da37e55e 100644 --- a/docs/docfiles/intro.rst +++ b/docs/docfiles/intro.rst @@ -1,17 +1,14 @@ -Welcome to Data-parallel Control (dpctl)'s documentation! -========================================================= +Data-Parallel Control - The Library That Controls XPUs +======================================================= -The data-parallel control (dpctl) library provides C and Python bindings for -`SYCL 2020 `_. -The SYCL 2020 features supported by dpctl are limited to those included by -Intel's DPCPP compiler and specifically cover the SYCL runtime classes described -in `Section 4.6 `_ -of the SYCL 2020 specification. Apart from the bindings for these runtime -classes, dpctl includes bindings for SYCL USM memory allocators and -deallocators. Dpctl's Python API provides classes that implement -`Python buffer protocol `_ -using SYCL USM memory; making it possible to create Python objects that are -backed by SYCL USM memory. +Data Parallel Control ``dpctl`` is the Python library that controls multiple devices of a platform, features classes for +unified shared memory (USM) management, and implements tensor array API on top of it. It is a foundational part of +a larger family of libraries and tools for Data Parallel Python (DPPY) aimed to program XPUs the same way as CPUs. -Dpctl also supports the DPCPP ``ONEAPI::filter_selector`` extension and has -experimental support for SYCL's ``kernel`` and ``program`` classes. +The ``dpctl`` library is built upon `SYCL standard` and implements a subset of +`runtime classes specifications`, +which allow users to query SYCL platforms, discover and represent SYCL devices, and construct SYCL queues for execution +of data-parallel code. + +The library also assists authors of Python native extensions written in C, Cython, or pybind11 to access objects +representing devices, queues, memory, and tensor array APIs. \ No newline at end of file