diff --git a/docs/sources/_images/DPEP-large.png b/docs/sources/_images/DPEP-large.png new file mode 100644 index 0000000..0ccbb3d Binary files /dev/null and b/docs/sources/_images/DPEP-large.png differ diff --git a/docs/sources/ext_links.txt b/docs/sources/ext_links.txt new file mode 100644 index 0000000..40a4694 --- /dev/null +++ b/docs/sources/ext_links.txt @@ -0,0 +1,7 @@ +.. + ********************************************************** + THESE ARE EXTERNAL PROJECT LINKS USED IN THE DOCUMENTATION + ********************************************************** +.. _NumPy*: https://numpy.org/ +.. _Numba*: https://numba.pydata.org/ +.. _Python Array API Standard: https://data-apis.org/array-api/ diff --git a/docs/sources/heterogeneous_computing.rst b/docs/sources/heterogeneous_computing.rst new file mode 100644 index 0000000..ffdef5f --- /dev/null +++ b/docs/sources/heterogeneous_computing.rst @@ -0,0 +1,5 @@ +.. _heterogeneous_computing: +.. include:: ./ext_links.txt + +Heterogeneous computing +======================= diff --git a/docs/sources/index.rst b/docs/sources/index.rst index ac81a52..adfae03 100644 --- a/docs/sources/index.rst +++ b/docs/sources/index.rst @@ -1,34 +1,32 @@ -.. documentation master file, created by - sphinx-quickstart. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to DPPY documentation! -====================================== - -... - -About -===== - -... - -License -======= - -... - -Indices and tables -================== - -.. only:: builder_html - - * :ref:`genindex` - * :ref:`modindex` - * :ref:`search` - -.. only:: not builder_html - - * :ref:`modindex` - -.. |reg| unicode:: U+000AE .. REGISTERED SIGN +.. _index: +.. include:: ./ext_links.txt + +.. image:: ./_images/dpep-large.png + :width: 400px + :align: center + :alt: Data Parallel Extensions for Python + +Data Parallel Extensions for Python +=================================== + +Data Parallel Extensions for Python* extend numerical Python capabilities beyond CPU and allow even higher performance +gains on data parallel devices such as GPUs. It consists of three foundational packages: + +* **dpnp** - Data Parallel Extensions for `Numpy*`_ - a library that implements a subset of + Numpy that can be executed on any data parallel device. The subset is a drop-in replacement + of core Numpy functions and numerical data types. +* **numba_dpex** - Data Parallel Extensions for `Numba*`_ - extension for Numba compiler + that enables programming data parallel devices the same way you program CPU with Numba. +* **dpctl - Data Parallel Control library** that provides utilities for device selection, + allocation of data on devices, tensor data structure along with `Python Array API Standard`_ implementation, and support for creation of user-defined data-parallel extensions. + +Table of Contents +***************** +.. toctree:: + :maxdepth: 2 + + prerequisites_and_installation + parallelism + heterogeneous_computing + programming_dpep + useful_links diff --git a/docs/sources/parallelism.rst b/docs/sources/parallelism.rst new file mode 100644 index 0000000..e1a5a00 --- /dev/null +++ b/docs/sources/parallelism.rst @@ -0,0 +1,5 @@ +.. _parallelism: +.. include:: ./ext_links.txt + +Parallelism in modern data parallel architectures +================================================= diff --git a/docs/sources/prerequisites_and_installation.rst b/docs/sources/prerequisites_and_installation.rst new file mode 100644 index 0000000..3f35ed6 --- /dev/null +++ b/docs/sources/prerequisites_and_installation.rst @@ -0,0 +1,5 @@ +.. _prerequisites_and_installation: +.. include:: ./ext_links.txt + +Prerequisites and installation +============================== diff --git a/docs/sources/programming_dpep.rst b/docs/sources/programming_dpep.rst new file mode 100644 index 0000000..868c95b --- /dev/null +++ b/docs/sources/programming_dpep.rst @@ -0,0 +1,5 @@ +.. _programming_dpep: +.. include:: ./ext_links.txt + +Programming with Data Parallel Extensions for Python +==================================================== diff --git a/docs/sources/sdc-sphinx-theme/static/sdc.css b/docs/sources/sdc-sphinx-theme/static/sdc.css index 4e0b8fe..30cefc9 100644 --- a/docs/sources/sdc-sphinx-theme/static/sdc.css +++ b/docs/sources/sdc-sphinx-theme/static/sdc.css @@ -95,7 +95,7 @@ ol { } li { line-height: 18px; - color: #0070c5; + color: #000010; } ul.unstyled { list-style: none; @@ -246,20 +246,6 @@ div.topbar { width: 100%; } -/* Intel logo png */ -/* -div.topbar a.brand { - width: 50px; - float: left; - display: block; - height: 60px; - padding: 8px 12px 0px 45px; - margin-left: -10px; - background: transparent url("intel_logo.png") no-repeat 10px 4px; - background-size: 86px 60px; -} -*/ - /* Scalable Dataframe Compiler png */ div.topbar a.brand_sdc { width: 200px; diff --git a/docs/sources/useful_links.rst b/docs/sources/useful_links.rst new file mode 100644 index 0000000..3084b4a --- /dev/null +++ b/docs/sources/useful_links.rst @@ -0,0 +1,5 @@ +.. _useful_links: +.. include:: ./ext_links.txt + +Useful links +============