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.

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) Fix install instructions for all shells #3864

Merged
merged 10 commits into from
Jul 23, 2024
24 changes: 12 additions & 12 deletions doc/locales/fr/LC_MESSAGES/framework-docs.po
Original file line number Diff line number Diff line change
Expand Up @@ -650,8 +650,8 @@ msgid "``pip install -U --pre flwr`` (without extras)"
msgstr "``pip install -U --pre flwr`` (sans les extras)"

#: ../../source/contributor-how-to-install-development-versions.rst:33
msgid "``pip install -U --pre flwr[simulation]`` (with extras)"
msgstr "``pip install -U --pre flwr[simulation]`` (avec les extras)"
msgid "``pip install -U --pre 'flwr[simulation]'`` (with extras)"
msgstr "``pip install -U --pre 'flwr[simulation]'`` (avec les extras)"

#: ../../source/contributor-how-to-install-development-versions.rst:35
msgid ""
Expand All @@ -676,10 +676,10 @@ msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:40
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git`` "
"``pip install 'flwr[simulation]@git+https:/adap/flower.git'`` "
"(with extras)"
msgstr ""
"``pip install flwr[simulation]@git+https:/adap/flower.git`` "
"``pip install 'flwr[simulation]@git+https:/adap/flower.git'`` "
"(avec les extras)"

#: ../../source/contributor-how-to-install-development-versions.rst:42
Expand All @@ -698,11 +698,11 @@ msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:45
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git"
"@branch-name`` (with extras)"
"``pip install 'flwr[simulation]@git+https:/adap/flower.git``"
"@branch-name'`` (with extras)"
msgstr ""
"``pip install flwr[simulation]@git+https:/adap/flower.git"
"@nom-de-branche`` (avec des extras)"
"``pip install 'flwr[simulation]@git+https:/adap/flower.git``"
"@nom-de-la-branche'`` (avec des extras)"

#: ../../source/contributor-how-to-install-development-versions.rst:49
msgid "Open Jupyter Notebooks on Google Colab"
Expand Down Expand Up @@ -6963,10 +6963,10 @@ msgstr ""

#: ../../source/how-to-upgrade-to-flower-1.0.rst:15
msgid ""
"``python -m pip install -U flwr[simulation]`` (when using "
"``python -m pip install -U 'flwr[simulation]'`` (when using "
"``start_simulation``)"
msgstr ""
"``python -m pip install -U flwr[simulation]`` (lors de l'utilisation de "
"``python -m pip install -U 'flwr[simulation]'`` (lors de l'utilisation de "
"``start_simulation``)"

#: ../../source/how-to-upgrade-to-flower-1.0.rst:17
Expand Down Expand Up @@ -20007,12 +20007,12 @@ msgid ""
"Simulations (using the Virtual Client Engine through `start_simulation`) "
"now work more smoothly on Jupyter Notebooks (incl. Google Colab) after "
"installing Flower with the `simulation` extra (`pip install "
"flwr[simulation]`)."
"'flwr[simulation]'`)."
msgstr ""
"Les simulations (utilisant le moteur de client virtuel via "
"`start_simulation`) fonctionnent maintenant plus facilement sur les "
"Notebooks Jupyter (y compris Google Colab) après avoir installé Flower "
"avec l'option `simulation` (`pip install flwr[simulation]`)."
"avec l'option `simulation` (`pip install 'flwr[simulation]'`)."

#: ../../source/ref-changelog.md:887
msgid ""
Expand Down
22 changes: 11 additions & 11 deletions doc/locales/ko/LC_MESSAGES/framework-docs.po
Original file line number Diff line number Diff line change
Expand Up @@ -666,8 +666,8 @@ msgid "``pip install -U --pre flwr`` (without extras)"
msgstr "``pip install -U --pre flwr`` (extras 제외)"

#: ../../source/contributor-how-to-install-development-versions.rst:33
msgid "``pip install -U --pre flwr[simulation]`` (with extras)"
msgstr "``pip install -U --pre flwr[simulation]`` (extras 포함)"
msgid "``pip install -U --pre 'flwr[simulation]'`` (with extras)"
msgstr "``pip install -U --pre 'flwr[simulation]'`` (extras 포함)"

#: ../../source/contributor-how-to-install-development-versions.rst:35
msgid ""
Expand All @@ -689,10 +689,10 @@ msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:40
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git`` "
"``pip install 'flwr[simulation]@git+https:/adap/flower.git'`` "
"(with extras)"
msgstr ""
"``pip install flwr[simulation]@git+https:/adap/flower.git`` "
"``pip install 'flwr[simulation]@git+https:/adap/flower.git'`` "
"(extras 포함)"

#: ../../source/contributor-how-to-install-development-versions.rst:42
Expand All @@ -709,11 +709,11 @@ msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:45
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git@branch-"
"name`` (with extras)"
"``pip install 'flwr[simulation]@git+https:/adap/flower.git@branch-"
"name'`` (with extras)"
msgstr ""
"``pip install flwr[simulation]@git+https:/adap/flower.git@branch-"
"name`` (extras 포함)"
"``pip install 'flwr[simulation]@git+https:/adap/flower.git@branch-"
"name'`` (extras 포함)"

#: ../../source/contributor-how-to-install-development-versions.rst:49
msgid "Open Jupyter Notebooks on Google Colab"
Expand Down Expand Up @@ -7021,10 +7021,10 @@ msgstr ""

#: ../../source/how-to-upgrade-to-flower-1.0.rst:15
msgid ""
"``python -m pip install -U flwr[simulation]`` (when using "
"``python -m pip install -U 'flwr[simulation]'`` (when using "
"``start_simulation``)"
msgstr ""
"``python -m pip install -U flwr[simulation]``(``start_simulation`` 사용 시)"
"``python -m pip install -U 'flwr[simulation]'``(``start_simulation`` 사용 시)"

#: ../../source/how-to-upgrade-to-flower-1.0.rst:17
msgid ""
Expand Down Expand Up @@ -18594,7 +18594,7 @@ msgid ""
"Simulations (using the Virtual Client Engine through `start_simulation`) now "
"work more smoothly on Jupyter Notebooks (incl. Google Colab) after "
"installing Flower with the `simulation` extra (`pip install "
"flwr[simulation]`)."
"'flwr[simulation]'`)."
msgstr ""

#: ../../source/ref-changelog.md:887
Expand Down
12 changes: 6 additions & 6 deletions doc/locales/pt_BR/LC_MESSAGES/framework-docs.po
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,7 @@ msgid "``pip install -U --pre flwr`` (without extras)"
msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:33
msgid "``pip install -U --pre flwr[simulation]`` (with extras)"
msgid "``pip install -U --pre 'flwr[simulation]'`` (with extras)"
msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:35
Expand All @@ -695,7 +695,7 @@ msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:40
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git`` "
"``pip install 'flwr[simulation]@git+https:/adap/flower.git'`` "
"(with extras)"
msgstr ""

Expand All @@ -711,8 +711,8 @@ msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:45
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git"
"@branch-name`` (with extras)"
"``pip install 'flwr[simulation]@git+https:/adap/flower.git"
"@branch-name'`` (with extras)"
msgstr ""

#: ../../source/contributor-how-to-install-development-versions.rst:49
Expand Down Expand Up @@ -5758,7 +5758,7 @@ msgstr ""

#: ../../source/how-to-upgrade-to-flower-1.0.rst:15
msgid ""
"``python -m pip install -U flwr[simulation]`` (when using "
"``python -m pip install -U 'flwr[simulation]'`` (when using "
"``start_simulation``)"
msgstr ""

Expand Down Expand Up @@ -17221,7 +17221,7 @@ msgid ""
"Simulations (using the Virtual Client Engine through `start_simulation`) "
"now work more smoothly on Jupyter Notebooks (incl. Google Colab) after "
"installing Flower with the `simulation` extra (`pip install "
"flwr[simulation]`)."
"'flwr[simulation]'`)."
msgstr ""

#: ../../source/ref-changelog.md:887
Expand Down
30 changes: 15 additions & 15 deletions doc/locales/zh_Hans/LC_MESSAGES/framework-docs.po
Original file line number Diff line number Diff line change
Expand Up @@ -664,11 +664,11 @@ msgstr "从 PyPI 安装 ``flwr`` 预发行版:"

#: ../../source/contributor-how-to-install-development-versions.rst:32
msgid "``pip install -U --pre flwr`` (without extras)"
msgstr "`pip install -U -pre flwr``(不含额外功能)"
msgstr "``pip install -U -pre flwr``(不含额外功能)"

#: ../../source/contributor-how-to-install-development-versions.rst:33
msgid "``pip install -U --pre flwr[simulation]`` (with extras)"
msgstr "`pip install -U -pre flwr[simulation]``(包含额外功能)"
msgid "``pip install -U --pre 'flwr[simulation]'`` (with extras)"
msgstr "``pip install -U -pre 'flwr[simulation]'``(包含额外功能)"

#: ../../source/contributor-how-to-install-development-versions.rst:35
msgid ""
Expand All @@ -684,15 +684,15 @@ msgstr "从 GitHub 的默认分支 (``main`) 安装 ``flwr``:"
msgid ""
"``pip install flwr@git+https:/adap/flower.git`` (without "
"extras)"
msgstr "`pip install flwr@git+https:/adap/flower.git`` (不含额外功能)"
msgstr "``pip install flwr@git+https:/adap/flower.git`` (不含额外功能)"

#: ../../source/contributor-how-to-install-development-versions.rst:40
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git`` "
"``pip install 'flwr[simulation]@git+https:/adap/flower.git'`` "
"(with extras)"
msgstr ""
"`pip install "
"flwr[simulation]@git+https:/adap/flower.git``(带附加功能)"
"``pip install "
"'flwr[simulation]@git+https:/adap/flower.git'``(带附加功能)"

#: ../../source/contributor-how-to-install-development-versions.rst:42
msgid "Install ``flwr`` from a specific GitHub branch (``branch-name``):"
Expand All @@ -703,14 +703,14 @@ msgid ""
"``pip install flwr@git+https:/adap/flower.git@branch-name`` "
"(without extras)"
msgstr ""
"`pip install flwr@git+https:/adap/flower.git@branch-name`` "
"``pip install flwr@git+https:/adap/flower.git@branch-name`` "
"(不含附加功能)"

#: ../../source/contributor-how-to-install-development-versions.rst:45
msgid ""
"``pip install flwr[simulation]@git+https:/adap/flower.git"
"@branch-name`` (with extras)"
msgstr "`pip安装flwr[模拟]@git+https:/adap/flower.git@分支名``(带附加功能)"
"``pip install 'flwr[simulation]@git+https:/adap/flower.git"
"@branch-name'`` (with extras)"
msgstr "``pip install 'flwr[simulation]@git+https:/adap/flower.git@分支名'``(带附加功能)"

#: ../../source/contributor-how-to-install-development-versions.rst:49
msgid "Open Jupyter Notebooks on Google Colab"
Expand Down Expand Up @@ -6561,9 +6561,9 @@ msgstr "`python -m pip install -U flwr``(当使用`start_server`和`start_clie

#: ../../source/how-to-upgrade-to-flower-1.0.rst:15
msgid ""
"``python -m pip install -U flwr[simulation]`` (when using "
"``python -m pip install -U 'flwr[simulation]'`` (when using "
"``start_simulation``)"
msgstr "`python -m pip install -U flwr[simulation]``(当使用`start_simulation``时)"
msgstr "``python -m pip install -U 'flwr[simulation]'``(当使用`start_simulation``时)"

#: ../../source/how-to-upgrade-to-flower-1.0.rst:17
msgid ""
Expand Down Expand Up @@ -21363,10 +21363,10 @@ msgid ""
"Simulations (using the Virtual Client Engine through `start_simulation`) "
"now work more smoothly on Jupyter Notebooks (incl. Google Colab) after "
"installing Flower with the `simulation` extra (`pip install "
"flwr[simulation]`)."
"'flwr[simulation]'`)."
msgstr ""
"通过 `start_simulation` 在 Jupyter 笔记本(包括 Google Colab)上安装 Flower 并附加 "
"`simulation` (`pip install flwr[simulation]`)后,模拟(通过 `start_simulation` "
"`simulation` (`pip install 'flwr[simulation]'`)后,模拟(通过 `start_simulation` "
"使用虚拟客户端引擎)现在可以更流畅地运行。"

#: ../../source/ref-changelog.md:887
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,19 @@ Using pip (recommended on Colab)
Install a ``flwr`` pre-release from PyPI:

- ``pip install -U --pre flwr`` (without extras)
- ``pip install -U --pre flwr[simulation]`` (with extras)
- ``pip install -U --pre 'flwr[simulation]'`` (with extras)

Python packages can be installed from git repositories. Use one of the following commands to install the Flower directly from GitHub.

Install ``flwr`` from the default GitHub branch (``main``):

- ``pip install flwr@git+https:/adap/flower.git`` (without extras)
- ``pip install flwr[simulation]@git+https:/adap/flower.git`` (with extras)
- ``pip install 'flwr[simulation]@git+https:/adap/flower.git'`` (with extras)

Install ``flwr`` from a specific GitHub branch (``branch-name``):

- ``pip install flwr@git+https:/adap/flower.git@branch-name`` (without extras)
- ``pip install flwr[simulation]@git+https:/adap/flower.git@branch-name`` (with extras)
- ``pip install 'flwr[simulation]@git+https:/adap/flower.git@branch-name'`` (with extras)


Open Jupyter Notebooks on Google Colab
Expand Down
2 changes: 1 addition & 1 deletion doc/source/how-to-install-flower.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ New (possibly unstable) versions of Flower are sometimes available as pre-releas

For simulations that use the Virtual Client Engine, ``flwr`` pre-releases should be installed with the ``simulation`` extra::

python -m pip install -U --pre flwr[simulation]
python -m pip install -U --pre 'flwr[simulation]'

Install nightly release
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion doc/source/how-to-upgrade-to-flower-1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Here's how to update an existing installation to Flower 1.0 using either pip or
- pip: add ``-U`` when installing.

- ``python -m pip install -U flwr`` (when using ``start_server`` and ``start_client``)
- ``python -m pip install -U flwr[simulation]`` (when using ``start_simulation``)
- ``python -m pip install -U 'flwr[simulation]'`` (when using ``start_simulation``)

- Poetry: update the ``flwr`` dependency in ``pyproject.toml`` and then reinstall (don't forget to delete ``poetry.lock`` via ``rm poetry.lock`` before running ``poetry install``).

Expand Down
2 changes: 1 addition & 1 deletion doc/source/how-to-upgrade-to-flower-next.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ or if you need Flower Next with simulation:

.. code-block:: bash

$ python -m pip install -U flwr[simulation]
$ python -m pip install -U "flwr[simulation]"


Ensure you set the following version constraint in your ``requirements.txt``
Expand Down
2 changes: 1 addition & 1 deletion doc/source/ref-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,7 @@ We would like to give our **special thanks** to all the contributors who made Fl

- **Improved Virtual Client Engine compatibility with Jupyter Notebook / Google Colab** ([#866](https:/adap/flower/pull/866), [#872](https:/adap/flower/pull/872), [#833](https:/adap/flower/pull/833), [#1036](https:/adap/flower/pull/1036))

Simulations (using the Virtual Client Engine through `start_simulation`) now work more smoothly on Jupyter Notebooks (incl. Google Colab) after installing Flower with the `simulation` extra (`pip install flwr[simulation]`).
Simulations (using the Virtual Client Engine through `start_simulation`) now work more smoothly on Jupyter Notebooks (incl. Google Colab) after installing Flower with the `simulation` extra (`pip install 'flwr[simulation]'`).

- **New Jupyter Notebook code example** ([#833](https:/adap/flower/pull/833))

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

To install the necessary dependencies, install `flwr` with the `simulation` extra:

pip install -U flwr["simulation"]
pip install -U "flwr[simulation]"
"""


Expand Down
2 changes: 1 addition & 1 deletion src/py/flwr/simulation/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

To install the necessary dependencies, install `flwr` with the `simulation` extra:

pip install -U flwr["simulation"]
pip install -U "flwr[simulation]"
"""

def start_simulation(*args, **kwargs): # type: ignore
Expand Down