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

[docs] [testing] gpu decorators table #8422

Merged
merged 4 commits into from
Nov 9, 2020
Merged

[docs] [testing] gpu decorators table #8422

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5eaea73
gpu decorators table
stas00 Nov 9, 2020
4ea9570
whitespace
stas00 Nov 9, 2020
be5624c
Update docs/source/testing.rst
stas00 Nov 9, 2020
85bd577
whitespace
stas00 Nov 9, 2020
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
16 changes: 16 additions & 0 deletions docs/source/testing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,22 @@ decorators are used to set the requirements of tests CPU/GPU/TPU-wise:
* ``require_torch_non_multigpu`` - as ``require_torch`` plus requires 0 or 1 GPUs
* ``require_torch_tpu`` - as ``require_torch`` plus requires at least 1 TPU

Let's depict the GPU requirements in the following table:


+----------+---------------------------------+
| n gpus | decorator |
+==========+=================================+
| ``>= 0`` | ``@require_torch`` |
+----------+---------------------------------+
| ``>= 1`` | ``@require_torch_gpu`` |
+----------+---------------------------------+
| ``>= 2`` | ``@require_torch_multigpu`` |
+----------+---------------------------------+
| `` < 2`` | ``@require_torch_non_multigpu`` |
stas00 marked this conversation as resolved.
Show resolved Hide resolved
+----------+---------------------------------+


For example, here is a test that must be run only when there are 2 or more GPUs available and pytorch is installed:

.. code-block:: python
Expand Down