Skip to content

Commit

Permalink
docs(framework:skip) Add FLWR_VERSION_REF to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Robert Steiner <[email protected]>
  • Loading branch information
Robert-Steiner committed Sep 6, 2024
1 parent ceb3903 commit 255e0b3
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions doc/source/contributor-how-to-build-docker-images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Before we can start, we need to meet a few prerequisites in our local developmen
default values, others must be specified when building the image. All available build arguments for
each image are listed in one of the tables below.

Building the base image
Building the Base Image
-----------------------

.. list-table::
Expand Down Expand Up @@ -65,6 +65,10 @@ Building the base image
- The Flower package to be installed.
- No
- ``flwr`` or ``flwr-nightly``
* - ``FLWR_VERSION_REF``
- A `direct reference <https://packaging.python.org/en/latest/specifications/version-specifiers/#direct-references>`_ without the ``@`` specifier. If both ``FLWR_VERSION`` and ``FLWR_VERSION_REF`` are specified, the ``FLWR_VERSION_REF`` has precedence.
- No
- `Direct Reference Examples`_

The following example creates a base Ubuntu/Alpine image with Python ``3.11.0``,
pip :substitution-code:`|pip_version|`, setuptools :substitution-code:`|setuptools_version|`
Expand All @@ -84,8 +88,8 @@ and Flower :substitution-code:`|stable_flwr_version|`:
In this example, we specify our image name as ``flwr_base`` and the tag as ``0.1.0``. Remember that the build arguments as well
as the name and tag can be adapted to your needs. These values serve as examples only.

Building the SuperLink/SuperNode or ServerApp image
---------------------------------------------------
Building a Flower Binary Image
------------------------------

.. list-table::
:widths: 25 45 15 15
Expand Down Expand Up @@ -130,3 +134,21 @@ After creating the image, we can test whether the image is working:
.. code-block:: bash
$ docker run --rm flwr_superlink:0.1.0 --help
Direct Reference Examples
-------------------------

.. code-block:: bash
:substitutions:
# main branch
git+https://github.com/adap/flower.git@main
# commit hash
git+https://github.com/adap/flower.git@1187c707f1894924bfa693d99611cf6f93431835
# tag
git+https://github.com/adap/flower.git@|stable_flwr_version|
# artifact store
https://artifact.flower.ai/py/main/latest/flwr-|stable_flwr_version|-py3-none-any.whl

0 comments on commit 255e0b3

Please sign in to comment.