From ef032ddd1e7b7260ae6f57e83f4de4cfdb824e7d Mon Sep 17 00:00:00 2001 From: Stas Bekman Date: Mon, 9 Nov 2020 11:27:42 -0800 Subject: [PATCH] [docs] [testing] gpu decorators table (#8422) * gpu decorators table * whitespace * Update docs/source/testing.rst Co-authored-by: Lysandre Debut * whitespace Co-authored-by: Lysandre Debut --- docs/source/testing.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/source/testing.rst b/docs/source/testing.rst index 0a9d3d525b..b9881757e7 100644 --- a/docs/source/testing.rst +++ b/docs/source/testing.rst @@ -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`` | ++----------+---------------------------------+ + + 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