Skip to content

Commit

Permalink
Update quickstart.rst (#968)
Browse files Browse the repository at this point in the history
Signed-off-by: manuelhsantana <[email protected]>
  • Loading branch information
psfoley authored and manuelhsantana committed Jul 9, 2024
1 parent 16f2604 commit 82b8f9e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/get_started/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. # Copyright (C) 2020-2023 Intel Corporation
.. # Copyright (C) 2020-2024 Intel Corporation
.. # SPDX-License-Identifier: Apache-2.0
.. _quick_start:
Expand All @@ -18,14 +18,16 @@ In this quick start guide, we will demonstrate how to run a simple federated lea
Creating a federation in 5 steps
********************************

To begin we recommend installing OpenFL inside a python virtual environment. This can be done with the following:
To begin we recommend installing the latest OpenFL inside a python virtual environment. This can be done with the following:

.. code-block:: console:

pip install virtualenv
virtualenv ~/openfl-quickstart
source ~/openfl-quickstart/bin/activate
pip install openfl
git clone https://github.com/securefederatedai/openfl.git
cd openfl
pip install .


Now you're ready to run your first federation! Copying these commands to your terminal will run a simple federation with an aggregator and two collaborators all on your local machine. These commands can be broken down into five steps, which you can read more about `here <../about/features_index/taskrunner.html#step-1-create-a-workspace>`_
Expand Down

0 comments on commit 82b8f9e

Please sign in to comment.