Skip to content

Commit

Permalink
Merge pull request #1342 from IntelPython/fix/group_barrier_docstring
Browse files Browse the repository at this point in the history
Fix docstring for group barrier and add todo for group barrier overload c6cfe7b
  • Loading branch information
github-actions[bot] committed Feb 16, 2024
1 parent 7ea8e36 commit 2564a3f
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 22 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 792aaac086a9c34e1e99219e7eb06ccb
config: d78f5c1e9ab2aab5ca5c3fe176d311b5
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,7 @@ Functions
The function is modeled after the ``sycl::group_barrier`` function. It
synchronizes work within a group of work items. All the work-items
of the group must execute the barrier construct before any work-item
continues execution beyond the barrier. However, unlike
``sycl::group_barrier`` the numba_dpex function implicitly synchronizes at
the level of a work group and does not allow specifying the group as an
argument. The :func:`sub_group_barrier` function should be used if
synchronization has to be performed only across a sub-group.
continues execution beyond the barrier.

The ``group_barrier`` performs mem-fence operations ensuring that memory
accesses issued before the barrier are not re-ordered with those issued
Expand Down
6 changes: 1 addition & 5 deletions dev/_sources/autoapi/numba_dpex/kernel_api/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -799,11 +799,7 @@ Functions
The function is modeled after the ``sycl::group_barrier`` function. It
synchronizes work within a group of work items. All the work-items
of the group must execute the barrier construct before any work-item
continues execution beyond the barrier. However, unlike
``sycl::group_barrier`` the numba_dpex function implicitly synchronizes at
the level of a work group and does not allow specifying the group as an
argument. The :func:`sub_group_barrier` function should be used if
synchronization has to be performed only across a sub-group.
continues execution beyond the barrier.

The ``group_barrier`` performs mem-fence operations ensuring that memory
accesses issued before the barrier are not re-ordered with those issued
Expand Down
6 changes: 1 addition & 5 deletions dev/autoapi/numba_dpex/kernel_api/barrier/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -288,11 +288,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
<p>The function is modeled after the <code class="docutils literal notranslate"><span class="pre">sycl::group_barrier</span></code> function. It
synchronizes work within a group of work items. All the work-items
of the group must execute the barrier construct before any work-item
continues execution beyond the barrier. However, unlike
<code class="docutils literal notranslate"><span class="pre">sycl::group_barrier</span></code> the numba_dpex function implicitly synchronizes at
the level of a work group and does not allow specifying the group as an
argument. The <code class="xref py py-func docutils literal notranslate"><span class="pre">sub_group_barrier()</span></code> function should be used if
synchronization has to be performed only across a sub-group.</p>
continues execution beyond the barrier.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">group_barrier</span></code> performs mem-fence operations ensuring that memory
accesses issued before the barrier are not re-ordered with those issued
after the barrier: all work-items in group g execute a release fence prior
Expand Down
6 changes: 1 addition & 5 deletions dev/autoapi/numba_dpex/kernel_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1245,11 +1245,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
<p>The function is modeled after the <code class="docutils literal notranslate"><span class="pre">sycl::group_barrier</span></code> function. It
synchronizes work within a group of work items. All the work-items
of the group must execute the barrier construct before any work-item
continues execution beyond the barrier. However, unlike
<code class="docutils literal notranslate"><span class="pre">sycl::group_barrier</span></code> the numba_dpex function implicitly synchronizes at
the level of a work group and does not allow specifying the group as an
argument. The <code class="xref py py-func docutils literal notranslate"><span class="pre">sub_group_barrier()</span></code> function should be used if
synchronization has to be performed only across a sub-group.</p>
continues execution beyond the barrier.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">group_barrier</span></code> performs mem-fence operations ensuring that memory
accesses issued before the barrier are not re-ordered with those issued
after the barrier: all work-items in group g execute a release fence prior
Expand Down
2 changes: 1 addition & 1 deletion dev/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 2564a3f

Please sign in to comment.