add req name arg to docs

scaleoutsystems · Jan 23, 2025 · b3c0c73 · b3c0c73
1 parent b2040cf
commit b3c0c73
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/docs/apiclient.rst b/docs/apiclient.rst
@@ -61,7 +61,7 @@ To set the active compute package in the FEDn Studio Project:
 
 .. code:: python
 
-   >>> client.set_active_package("package.tgz", helper="numpyhelper")
+   >>> client.set_active_package("package.tgz", helper="numpyhelper", name="my-package")
    >>> client.set_active_model("seed.npz")
 
 **Start a training session**

diff --git a/docs/developer.rst b/docs/developer.rst
@@ -38,7 +38,7 @@ so we will not require authentication of clients (insecure mode) when using the
 
    from fedn import APIClient
    client = APIClient(host="localhost", port=8092)
-   client.set_active_package("package.tgz", helper="numpyhelper")
+   client.set_active_package("package.tgz", helper="numpyhelper", name="my-package")
    client.set_active_model("seed.npz")
 
 To connect a native FEDn client to the sandbox deployment, you need to make sure that the combiner service can be resolved by the client using the name "combiner". 

diff --git a/examples/api-tutorials/API_Example.ipynb b/examples/api-tutorials/API_Example.ipynb
diff --git a/examples/api-tutorials/Aggregators.ipynb b/examples/api-tutorials/Aggregators.ipynb
@@ -73,7 +73,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "client.set_active_package('../mnist-pytorch/package.tgz', 'numpyhelper')\n",
+    "client.set_active_package('../mnist-pytorch/package.tgz', 'numpyhelper', 'mnist-pytorch')\n",
     "client.set_active_model('../mnist-pytorch/seed.npz')\n",
     "seed_model = client.get_active_model()\n",
     "print(seed_model)"

diff --git a/examples/api-tutorials/Hyperparameter_Tuning.ipynb b/examples/api-tutorials/Hyperparameter_Tuning.ipynb
@@ -62,7 +62,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "client.set_active_package('../mnist-pytorch/package.tgz', 'numpyhelper')\n",
+    "client.set_active_package('../mnist-pytorch/package.tgz', 'numpyhelper', 'mnist-pytorch')\n",
     "client.set_active_model('../mnist-pytorch/seed.npz')\n",
     "seed_model = client.get_active_model()"
    ]