chore: rename use_gpu to disable_gpu in TorchAlgo

Signed-off-by: ThibaultFy <[email protected]>
Substra · Aug 12, 2024 · eec0bd9 · eec0bd9
1 parent c642aa9
commit eec0bd9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/source/examples/substrafl/get_started/run_mnist_torch.ipynb b/docs/source/examples/substrafl/get_started/run_mnist_torch.ipynb
@@ -439,7 +439,7 @@
     "            index_generator=index_generator,\n",
     "            dataset=TorchDataset,\n",
     "            seed=seed,\n",
-    "            use_gpu=False,\n",
+    "            disable_gpu=True,\n",
     "        )"
    ]
   },
@@ -558,7 +558,7 @@
     "The [Dependency](https://docs.substra.org/en/stable/substrafl_doc/api/dependency.html) object is instantiated in order to install the right libraries in\n",
     "the Python environment of each organization.\n",
     "\n",
-    "The CPU torch version is installed here to have a `Dependency` object as light as possible as we don't use GPUs (`use_gpu` set to `False`). Remove the `--extra-index-url` to install the cuda torch version."
+    "The CPU torch version is installed here to have a `Dependency` object as light as possible as we don't use GPUs (`disable_gpu` set to `True`). Remove the `--extra-index-url` to install the cuda torch version."
    ]
   },
   {

diff --git a/docs/source/examples/substrafl/go_further/run_mnist_cyclic.ipynb b/docs/source/examples/substrafl/go_further/run_mnist_cyclic.ipynb
@@ -660,7 +660,7 @@
     "        index_generator: NpIndexGenerator,\n",
     "        dataset: torch.utils.data.Dataset,\n",
     "        seed: Optional[int] = None,\n",
-    "        use_gpu: bool = True,\n",
+    "        disable_gpu: bool = False,\n",
     "        *args,\n",
     "        **kwargs,\n",
     "    ):\n",
@@ -678,7 +678,7 @@
     "            dataset (torch.utils.data.Dataset): an instantiable dataset class whose ``__init__`` arguments are\n",
     "                ``x``, ``y`` and ``is_inference``.\n",
     "            seed (typing.Optional[int]): Seed set at the algo initialization on each organization. Defaults to None.\n",
-    "            use_gpu (bool): Whether to use the GPUs if they are available. Defaults to True.\n",
+    "            disable_gpu (bool): Force to disable GPUs usage. Defaults to False.\n",
     "        \"\"\"\n",
     "        super().__init__(\n",
     "            model=model,\n",
@@ -688,7 +688,7 @@
     "            dataset=dataset,\n",
     "            scheduler=None,\n",
     "            seed=seed,\n",
-    "            use_gpu=use_gpu,\n",
+    "            disable_gpu=disable_gpu,\n",
     "            *args,\n",
     "            **kwargs,\n",
     "        )\n",
@@ -815,7 +815,7 @@
     "            index_generator=index_generator,\n",
     "            dataset=TorchDataset,\n",
     "            seed=seed,\n",
-    "            use_gpu=False,\n",
+    "            disable_gpu=True,\n",
     "        )\n",
     "\n",
     "\n",