Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(framework:skip) Add FLWR_VERSION_REF to docs #4154

Merged
merged 4 commits into from
Sep 9, 2024
Merged

docs(framework:skip) Add FLWR_VERSION_REF to docs #4154

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
255e0b3
docs(framework:skip) Add FLWR_VERSION_REF to docs
Robert-Steiner Sep 6, 2024
cc5638f
Merge branch 'main' into doc/flwr-version-reference
Robert-Steiner Sep 9, 2024
ebf462e
Merge branch 'main' into doc/flwr-version-reference
tanertopal Sep 9, 2024
d350d67
Merge branch 'main' into doc/flwr-version-reference
tanertopal Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions doc/source/contributor-how-to-build-docker-images.rst
View file
Open in desktop
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