Fix/SK-1259 | Use api/v1 for set_active_package in APIClient (#775)

scaleoutsystems · Jan 23, 2025 · e475618 · e475618
1 parent a464c7a
commit e475618
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 8 deletions.
diff --git a/.ci/tests/examples/run.sh b/.ci/tests/examples/run.sh
@@ -38,7 +38,7 @@ python ../../.ci/tests/examples/wait_for.py reducer
 python ../../.ci/tests/examples/wait_for.py combiners
 
 >&2 echo "Upload compute package"
-python ../../.ci/tests/examples/api_test.py set_package --path package.tgz --helper "$helper"
+python ../../.ci/tests/examples/api_test.py set_package --path package.tgz --helper "$helper" --name test
 
 >&2 echo "Wait for clients to connect"
 python ../../.ci/tests/examples/wait_for.py clients

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()"
    ]

diff --git a/fedn/network/api/client.py b/fedn/network/api/client.py
@@ -428,7 +428,7 @@ def download_package(self, path: str):
         else:
             return {"success": False, "message": "Failed to download package."}
 
-    def set_active_package(self, path: str, helper: str, name: str = None, description: str = None):
+    def set_active_package(self, path: str, helper: str, name: str, description: str = ""):
         """Set the compute package in the statestore.
 
         :param path: The file path of the compute package to set.