Skip to content

Commit d934762

Browse files
committed
Review of beginners_guides section
1 parent 0df3bec commit d934762

File tree

3 files changed

+17
-16
lines changed

3 files changed

+17
-16
lines changed

docs/doc_sources/beginners_guides/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ to Python through invocations of oneAPI-based native libraries, their Python int
1212
or by using DPC++-based Python native extensions built using :mod:`dpctl` integration with
1313
Python native extension generators.
1414

15-
The :py:mod:`dpctl` runtime is built on top of the C++ SYCL-2020 standard as implemented in
15+
The :py:mod:`dpctl` runtime is built on top of the C++ SYCL 2020 standard as implemented in the
1616
`Intel(R) oneAPI DPC++ compiler <dpcpp_compiler>`_ and is designed to be both vendor and
1717
architecture agnostic.
1818

docs/doc_sources/beginners_guides/installation.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ Installing ``dpctl``
77
License
88
=======
99

10-
:py:mod:`dpctl` is licensed under Apache License 2.0 that can be found in
10+
:py:mod:`dpctl` is licensed under Apache* License 2.0 that can be found in the
1111
`LICENSE <dpctl_license_>`_ file.
1212
All usage and contributions to the project are subject to the terms and
1313
conditions of this license.
1414

1515
.. _dpctl_license: https://github.com/IntelPython/dpctl/blob/master/LICENSE
1616

17-
See user guide :ref:`document <user_guide_dpctl_license>` for additional information.
17+
See the user guide :ref:`document <user_guide_dpctl_license>` for additional information.
1818

1919
Installation using conda
2020
========================
@@ -24,24 +24,24 @@ ecosystem.
2424

2525
.. _conda_docs: https://docs.conda.io/projects/conda/en/stable/
2626

27-
Released versions of the package can be installed from Intel channel, as
27+
Released versions of the package can be installed from the Intel channel, as
2828
indicated by ``--channel intel`` option:
2929

3030
.. code-block:: bash
3131
:caption: Getting latest released version of ``dpctl`` using conda
3232
3333
conda create --name dpctl_env --channel intel dpctl
3434
35-
Development builds of ``dpctl`` can be accessed from ``dppy/label/dev`` channel:
35+
Development builds of ``dpctl`` can be accessed from the ``dppy/label/dev`` channel:
3636

3737
.. code-block:: bash
3838
:caption: Getting latest development version
3939
4040
conda create -n dpctl_nightly -c dppy/label/dev -c intel dpctl
4141
4242
.. note::
43-
In case :py:mod:`dpctl` is not available for the Python version of interest,
44-
please check `Building from source`_ section.
43+
If :py:mod:`dpctl` is not available for the Python version of interest,
44+
see `Building from source`_.
4545

4646

4747
Installation using pip
@@ -63,14 +63,14 @@ use
6363
python -m pip install --index-url https://pypi.anaconda.org/intel/simple dpctl
6464
6565
.. note::
66-
Installation using ``pip`` on Linux currently (as of April 2024) requires
66+
As of April 2024, installation using ``pip`` on Linux* requires
6767
that host operating system had ``libstdc++.so`` library version 6.0.29
6868
or later. Check the version you have by executing
6969
``find /lib/x86_64-linux-gnu/ -name "libstdc++*"``
7070

7171
.. note::
72-
In case :py:mod:`dpctl` is not available for the Python version of interest,
73-
please check `Building from source`_ section.
72+
If :py:mod:`dpctl` is not available for the Python version of interest,
73+
see `Building from source`_.
7474

7575

7676
Installation via Intel(R) Distribution for Python
@@ -87,7 +87,7 @@ Once the installed environment is activated, ``dpctl`` should be ready to use.
8787
System requirements
8888
===================
8989

90-
Since :py:mod:`dpctl` is compiled using Intel(R) oneAPI DPC++ compiler,
90+
Since :py:mod:`dpctl` is compiled using the Intel(R) oneAPI DPC++ compiler,
9191
the `compiler's system requirements for runtime <dpcpp_system_reqs_>`_ must be met.
9292

9393
In order for DPC++ runtime to recognize supported hardware appropriate drivers must be installed.
@@ -97,14 +97,15 @@ Directions to install drivers for Intel GPU devices are available at https://dgp
9797

9898
Once ``dpctl`` is installed, use ``python -m dpctl --full-list`` to list recognized devices.
9999

100-
For ``dpctl`` to target Intel GPU devices, appropriate drivers should be installed systemwide.
100+
For ``dpctl`` to target Intel GPU devices, appropriate drivers should be installed system wide.
101101
Please refer to `GPU installation guide <gpu_stack_installation_guide_>`_ for detailed
102102
instructions on how to install required drivers on Linux.
103103

104104
.. _gpu_stack_installation_guide: https://dgpu-docs.intel.com/
105105

106106
.. note::
107-
Instructions for setting up GPU drivers in Windows Subsystem for Linux (WSL) is forthcoming.
107+
Instructions for setting up GPU drivers in Windows Subsystem for Linux (WSL)
108+
will be added in a future release of this document.
108109

109110
Building from source
110111
====================
@@ -192,7 +193,7 @@ each example Python project and how to execute its test suite.
192193
Running the Python Tests
193194
------------------------
194195

195-
You can execute Python test suite of :py:mod:`dpctl` as follow:
196+
You can execute Python test suite of :py:mod:`dpctl` with:
196197

197198
.. code-block:: bash
198199

docs/doc_sources/beginners_guides/tensor_intro.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@ devices as well migration from :py:class:`numpy.ndarray` may be accomplished in
169169
# Array w has shape (3, 10, 10)
170170
w = tensor.asarray([x_cpu, x_gpu, x_np], device="level_zero:gpu")
171171
172-
Migration may also occur during calls to other array creation functions, e.g. :py:func:`full` when the `fill_value` parameter is an instance
173-
of :py:class:`usm_ndarray`. In such a case default values of device placement keywords are interpreted to avoid data migration, i.e. the
172+
Migration may also occur during calls to other array creation functions, e.g., :py:func:`full` when the `fill_value` parameter is an instance
173+
of :py:class:`usm_ndarray`. In such a case default values of device placement keywords are interpreted to avoid data migration, i.e., the
174174
new array is created on the same device where `fill_value` array was allocated.
175175

176176
.. code-block:: python

0 commit comments

Comments
 (0)