Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document completion queries for execution spaces #368

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Document completion queries for execution spaces #368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4437abe
Document completion queries for execution spaces
masterleinad May 1, 2023
949a06b
Improve description
masterleinad May 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/API/core/execution_spaces.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,8 @@ Functions

* ``const char* name() const;``: *Returns* the label of the execution space instance.

* ``bool is_running() const;``: *Returns* ``true`` if the execution space is currently executing a kernel, otherwise returns ``false``. Therefore, if the function returns ``false``, all kernels submitted by the current thread have been completed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Group comment:

  • Revisit once code PR finalized

* ``bool in_parallel() const;``: *Returns* a value convertible to ``bool`` indicating whether the caller is executing as part of a Kokkos parallel pattern. *Note:* as currently implemented, there is no guarantee that ``true`` means the caller is necessarily executing as part of a pattern on the particular instance |ExecutionSpaceConcept|_; just *some* instance of |ExecutionSpaceConcept|_. This may be strengthened in the future.

* ``int concurrency() const;`` *Returns* the maximum amount of concurrently executing work items in a parallel setting, i.e. the maximum number of threads utilized by an execution space instance.
Expand Down