docs(docker) Add ServerApps docs #3439

Robert-Steiner · 2024-05-13T14:59:22Z

Issue

Description

Adds documentation for the ServerApp.

Related issues/PRs

Proposal

Explanation

Checklist

Changelog entry

Any other comments?

Signed-off-by: Robert Steiner <robert@flower.ai>

chongshenng · 2024-05-14T14:32:53Z

doc/source/how-to-run-flower-using-docker.rst

+  If the requirement.txt contains the `flwr <https://pypi.org/project/flwr/>`__ or
+  `flwr-nightly <https://pypi.org/project/flwr-nightly/>`_ package, please ensure the version in
+  requirement.txt matches the docker image version.


AFAIK, we can skip installing flwr as long as the correct Docker image is used. Maybe we can rephrase as:

⚠️ Note that flwr is already installed in the flwr/supernode base image, so you only need to include other package dependencies in your requirements.txt, such as torch, tensorflow, etc ...

I think the way you phrased it sounds better. I will go with that. The reason I included the note is because I'm afraid users develop locally with a requirements.txt containing the flwr package and once they're done they just copy the same file into the Docker image.

I can see why that can be the case. Since this is a self-contained "How-to" page, I think it's important to start from the simplest setup. This basic Dockerfile can then be expanded by users for other more complicated server setups.

chongshenng · 2024-05-14T14:35:55Z

doc/source/how-to-run-flower-using-docker.rst

+A key difference is the additional argument in the ``ENTRYPOINT`` command of the ServerApp
+Dockerfile.


"A key difference is the different argument in the ENTRYPOINT command of the ServerApp Dockerfile."

The server:app argument can be passed in the same way as the client:app argument.

I removed it.

doc/source/how-to-run-flower-using-docker.rst

chongshenng · 2024-05-14T14:38:03Z

doc/source/how-to-run-flower-using-docker.rst

+  .
+  ├── server.py        # ServerApp code
+  ├── task.py          # ServerApp code
+  ├── requirements.txt # ServerApp dependencies


Technically, ServerApp does not need any other packages other than flwr. Let's remove requirements.txt as one of the required files in this tree.

In the examples/app-pytorch I need therequirements.txt because the ServerApp code uses the pytorch package but we can create our own example. wdyt?

Yes, let's adapt the examples. In fact, the quickstart-pytorch example is a better example to base this "How-to" on. For context, the app-pytorch uses a server-side model parameter intialization - that's why PyTorch is a dependency for running the ServerApp. For the quickstart-pytorch, it is a client-side parameter initialization - so all ML-related computation is done in the ClientApp. Can you please update the references to quickstart-pytorch instead?

Oh I didn't know that. That makes sense! I will update it to use the quickstart-pytorch example instead.

chongshenng · 2024-05-14T14:38:32Z

doc/source/how-to-run-flower-using-docker.rst

+  COPY requirements.txt .
+  RUN python -m pip install -U --no-cache-dir -r requirements.txt && pyenv rehash


We can remove requirements.txt and the installation of it in the ServerApp's Dockerfile.

doc/source/how-to-run-flower-using-docker.rst

chongshenng · 2024-05-14T14:45:37Z

doc/source/how-to-run-flower-using-docker.rst

+.. important::
+
+  If the requirement.txt contains the `flwr <https://pypi.org/project/flwr/>`__ or
+  `flwr-nightly <https://pypi.org/project/flwr-nightly/>`_ package, please ensure the version in
+  requirement.txt matches the docker image version.
+
+  Stable:
+
+  - Docker image: ``serverapp:1.8.0``
+  - requirement.txt: ``flwr[simulation]==1.8.0``
+
+  Nightly:
+
+  - Docker image: ``serverapp:1.9.0.dev20240501``
+  - requirement.txt: ``flwr-nightly[simulation]==1.9.0.dev20240501``


Since flwr is already installed in the base image, we can skip this step. Let's remove these lines.

chongshenng · 2024-05-14T14:49:17Z

doc/source/how-to-run-flower-using-docker.rst

+
+  $ docker run --rm flwr_serverapp:0.0.1 \
+    --insecure \
+    --server 192.168.1.100:9091


Should we adopt the Docker network approach here (and also for SuperLink and SuperNode)? I think it will be clearer overall since we can just use the --name instead of an IP address --server.

docker run \ --network flwr-net \ --rm flwr/serverapp:1.8.0 \ --insecure --server flwr-superlink:9091

I'm not sure since this only works if all containers are running on the same machine. We could add a note wdyt?

That's true. Maybe something like the following?

💡 To test running Flower locally, use the --network argument and pass the name of the Docker network to run your ServerApps.

Or did you have another comment in mind?

I took your comment and added a link to the Docker documentation on creating a bridge network.

chongshenng · 2024-05-14T14:50:27Z

doc/source/how-to-run-flower-using-docker.rst

+
+.. code-block:: bash
+
+  $ docker run --rm -v ./ca.crt:/app/ca.crt flwr_serverapp:0.0.1 client:app \


Let's use the full argument for consistency: docker run --rm --volume ...

Signed-off-by: Robert Steiner <robert@flower.ai>

chongshenng · 2024-05-15T08:30:33Z

doc/source/how-to-run-flower-using-docker.rst

@@ -117,7 +123,7 @@ building your own SuperNode image.
  day. To ensure the versions are in sync, using the concrete tag, e.g., ``1.9.0.dev20240501``
  instead of ``nightly`` is recommended.

-We will use the ``app-pytorch`` example, which you can find in
+We will use the ``quickstart-pytorch`` example, which you can find in
 the Flower repository, to illustrate how you can dockerize your client-app.


Rename client-app > ClientApp for consistency.

chongshenng · 2024-05-15T08:30:52Z

doc/source/how-to-run-flower-using-docker.rst

@@ -126,14 +132,14 @@ Prerequisites
 ~~~~~~~~~~~~~

 Before we can start, we need to meet a few prerequisites in our local development environment.
-You can skip the first part if you want to run your client-app instead of the ``app-pytorch``
+You can skip the first part if you want to run your client-app instead of the ``quickstart-pytorch``


Rename client-app > ClientApp for consistency.

Good catch!

Signed-off-by: Robert Steiner <robert@flower.ai>

chongshenng

LGTM! I only have minor formatting comments.

chongshenng · 2024-05-15T08:31:43Z

doc/source/how-to-run-flower-using-docker.rst

 example.

 #. Clone the flower repository.

    .. code-block:: bash

-      $ git clone https://github.com/adap/flower.git && cd flower/examples/app-pytorch
+      $ git clone https://github.com/adap/flower.git && cd flower/examples/quickstart-pytorch


- git clone https://github.com/adap/flower.git && cd flower/examples/quickstart-pytorch + git clone --depth=1 https://github.com/adap/flower.git && cd flower/examples/quickstart-pytorch

chongshenng · 2024-05-15T08:31:54Z

doc/source/how-to-run-flower-using-docker.rst

@@ -126,14 +132,14 @@ Prerequisites
 ~~~~~~~~~~~~~

 Before we can start, we need to meet a few prerequisites in our local development environment.
-You can skip the first part if you want to run your client-app instead of the ``app-pytorch``
+You can skip the first part if you want to run your client-app instead of the ``quickstart-pytorch``
 example.

 #. Clone the flower repository.


flower > Flower

chongshenng · 2024-05-15T08:33:50Z

doc/source/how-to-run-flower-using-docker.rst

+  base image, so you only need to include other package dependencies in your requirements.txt,
+  such as torch, tensorflow, etc.


... in your requirements.txt such as torch, tensorflow, etc.

chongshenng · 2024-05-15T08:35:39Z

doc/source/how-to-run-flower-using-docker.rst

-
-  - Docker image: ``supernode:1.9.0.dev20240501``
-  - requirement.txt: ``flwr-nightly[simulation]==1.9.0.dev20240501``
+we copy the ClientApp code into the image and set the entry point to ``flower-client-app`` with


we copy the client.py module into the image ...

chongshenng · 2024-05-15T08:48:22Z

doc/source/how-to-run-flower-using-docker.rst

-
-  - Docker image: ``serverapp:1.9.0.dev20240501``
-  - requirement.txt: ``flwr-nightly[simulation]==1.9.0.dev20240501``
+executed in the ``/app`` directory. In the last two lines, we copy the ServerApp code into the


..., we copy the ServerApp module into the ...

Should we call it ServerApp or server.py to be consistent with change above?

You're right @Robert-Steiner! Let's stick to server.py.

..., we copy the server.py module into the ...

Signed-off-by: Robert Steiner <robert@flower.ai>

chongshenng

LGTM, thanks @Robert-Steiner!

tanertopal

lgtm!

Robert-Steiner force-pushed the doc/serverapp-docker-docs branch 2 times, most recently from 3895c65 to 9c2fea8 Compare May 14, 2024 11:30

docs(docker) Add ServerApps docs

7a48176

Signed-off-by: Robert Steiner <robert@flower.ai>

Robert-Steiner force-pushed the doc/serverapp-docker-docs branch from 9c2fea8 to 7a48176 Compare May 14, 2024 14:19

chongshenng requested changes May 14, 2024

View reviewed changes

Robert-Steiner added 2 commits May 14, 2024 18:10

Address review comments

eb6b464

Signed-off-by: Robert Steiner <robert@flower.ai>

Update example

f1d1351

Signed-off-by: Robert Steiner <robert@flower.ai>

chongshenng reviewed May 15, 2024

View reviewed changes

Rename client-app to ClientApp

ffb27c2

Signed-off-by: Robert Steiner <robert@flower.ai>

chongshenng requested changes May 15, 2024

View reviewed changes

Addressing PR comments

6370fbc

Signed-off-by: Robert Steiner <robert@flower.ai>

Robert-Steiner self-assigned this May 15, 2024

Robert-Steiner requested a review from chongshenng May 15, 2024 15:57

chongshenng approved these changes May 15, 2024

View reviewed changes

Robert-Steiner marked this pull request as ready for review May 16, 2024 08:17

Robert-Steiner requested review from danieljanes and tanertopal as code owners May 16, 2024 08:17

Merge branch 'main' into doc/serverapp-docker-docs

5ebbbc9

tanertopal enabled auto-merge (squash) May 16, 2024 14:43

tanertopal approved these changes May 16, 2024

View reviewed changes

tanertopal merged commit 81c08fd into main May 16, 2024
28 checks passed

tanertopal deleted the doc/serverapp-docker-docs branch May 16, 2024 14:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(docker) Add ServerApps docs #3439

docs(docker) Add ServerApps docs #3439

Robert-Steiner commented May 13, 2024 •

edited

Loading

chongshenng May 14, 2024

Robert-Steiner May 14, 2024

chongshenng May 14, 2024

chongshenng May 14, 2024

Robert-Steiner May 15, 2024

chongshenng May 14, 2024

Robert-Steiner May 14, 2024

chongshenng May 14, 2024

Robert-Steiner May 15, 2024

chongshenng May 14, 2024

Robert-Steiner May 15, 2024

chongshenng May 14, 2024

chongshenng May 14, 2024

Robert-Steiner May 14, 2024

chongshenng May 14, 2024

Robert-Steiner May 15, 2024

chongshenng May 14, 2024

chongshenng May 15, 2024

chongshenng May 15, 2024

Robert-Steiner May 15, 2024

chongshenng left a comment

chongshenng May 15, 2024

chongshenng May 15, 2024

chongshenng May 15, 2024

chongshenng May 15, 2024

chongshenng May 15, 2024

Robert-Steiner May 15, 2024

chongshenng May 15, 2024

chongshenng left a comment

tanertopal left a comment

		A key difference is the additional argument in the ``ENTRYPOINT`` command of the ServerApp
		Dockerfile.

		COPY requirements.txt .
		RUN python -m pip install -U --no-cache-dir -r requirements.txt && pyenv rehash


		.. code-block:: bash

		$ docker run --rm -v ./ca.crt:/app/ca.crt flwr_serverapp:0.0.1 client:app \

		base image, so you only need to include other package dependencies in your requirements.txt,
		such as torch, tensorflow, etc.

docs(docker) Add ServerApps docs #3439

docs(docker) Add ServerApps docs #3439

Conversation

Robert-Steiner commented May 13, 2024 • edited Loading

Issue

Description

Related issues/PRs

Proposal

Explanation

Checklist

Changelog entry

Any other comments?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chongshenng left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chongshenng left a comment

Choose a reason for hiding this comment

tanertopal left a comment

Choose a reason for hiding this comment

Robert-Steiner commented May 13, 2024 •

edited

Loading