docs(framework:skip) Fix deployment engine guides (#4812)

adap · Jan 14, 2025 · c659d8a · c659d8a
1 parent 762c7a4
commit c659d8a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/framework/docs/source/how-to-authenticate-supernodes.rst b/framework/docs/source/how-to-authenticate-supernodes.rst
@@ -60,7 +60,7 @@ that the authentication feature can only be enabled in the presence of TLS.
 .. code-block:: bash
     :emphasize-lines: 5,6,7
 
-    flower-superlink \
+    $ flower-superlink \
         --ssl-ca-certfile certificates/ca.crt \
         --ssl-certfile certificates/server.pem \
         --ssl-keyfile certificates/server.key \
@@ -85,7 +85,7 @@ addition to the TLS certificate.
 .. code-block:: bash
     :emphasize-lines: 6, 7
 
-    flower-supernode \
+    $ flower-supernode \
         --root-certificates certificates/ca.crt \
         --superlink 127.0.0.1:9092 \
         --clientappio-api-address 0.0.0.0:9094 \

diff --git a/framework/docs/source/how-to-run-flower-with-deployment-engine.rst b/framework/docs/source/how-to-run-flower-with-deployment-engine.rst
@@ -66,6 +66,10 @@ Create a new Flower app (PyTorch), and follow the instructions show upon executi
 
 .. note::
 
+    You might want to update the ``torch`` and ``torchvision`` packages that come with
+    the proejct to the latets released versions. Do so with: ``pip install -U torch
+    torchvision``.
+
     If you decide to run the project with ``flwr run .``, the Simulation Engine will be
     used. Continue to Step 2 to know how to instead use the Deployment Engine.
 
@@ -121,7 +125,7 @@ You will need two terminals for this step.
        $ flower-supernode \
             --insecure \
             --superlink 127.0.0.1:9092 \
-            --clientappio-address 127.0.0.1:9094 \
+            --clientappio-api-address 127.0.0.1:9094 \
             --node-config "partition-id=0 num-partitions=2"
 
    .. dropdown:: Understand the command
@@ -142,7 +146,7 @@ You will need two terminals for this step.
        $ flower-supernode \
             --insecure \
             --superlink 127.0.0.1:9092 \
-            --clientappio-address 127.0.0.1:9095 \
+            --clientappio-api-address 127.0.0.1:9095 \
             --node-config "partition-id=1 num-partitions=2"
 
    .. dropdown:: Understand the command