Add docs to install whl on Colab (#2316)

adap · Sep 7, 2023 · 564e14b · 564e14b
1 parent 9761f20
commit 564e14b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/doc/source/contributor-how-to-install-development-versions.rst b/doc/source/contributor-how-to-install-development-versions.rst
@@ -55,3 +55,9 @@ Open the notebook ``doc/source/tutorial-get-started-with-flower-pytorch.ipynb``:
 Open a development version of the same notebook from branch `branch-name` by changing ``main`` to ``branch-name`` (right after ``blob``):
 
 - https://colab.research.google.com/github/adap/flower/blob/branch-name/doc/source/tutorial-get-started-with-flower-pytorch.ipynb
+
+Install a `whl` on Google Colab:
+
+1. In the vertical icon grid on the left hand side, select ``Files`` > ``Upload to session storage``
+2. Upload the whl (e.g., ``flwr-1.6.0-py3-none-any.whl``)
+3. Change ``!pip install -q 'flwr[simulation]' torch torchvision matplotlib`` to ``!pip install -q 'flwr-1.6.0-py3-none-any.whl[simulation]' torch torchvision matplotlib``
diff --git a/doc/source/ref-changelog.md b/doc/source/ref-changelog.md
@@ -6,7 +6,7 @@
 
 - **General updates to baselines** ([#2301](https:/adap/flower/pull/2301).[#2305](https:/adap/flower/pull/2305), [#2307](https:/adap/flower/pull/2307))
 
-- **General improvements** ([#2309](https:/adap/flower/pull/2309), [#2310](https:/adap/flower/pull/2310), [2313](https:/adap/flower/pull/2313), [2317](https:/adap/flower/pull/2317))
+- **General improvements** ([#2309](https:/adap/flower/pull/2309), [#2310](https:/adap/flower/pull/2310), [2313](https:/adap/flower/pull/2313), [#2316](https:/adap/flower/pull/2316), [2317](https:/adap/flower/pull/2317))
 
  Flower received many improvements under the hood, too many to list here.