Skip to content

Commit

Permalink
Clarify that we only use the example from the local clone of fedn
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas Hellander committed Jul 9, 2024
1 parent 005110f commit 5557489
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ Next, we will prepare the client. For illustrative purposes, we use one of the p
In order to train a federated model using FEDn, your Studio project needs to be initialized with a ``compute package`` and a ``seed model``. The compute package is a code bundle containing the
code used by the client to execute local training and local validation. The seed model is a first version of the global model. For a detailed explaination of the compute package and seed model, see this guide: :ref:`projects-label`

Clone the FEDn repository:
To work through this quick start you need a local copy of the ``mnist-pytorch`` example project contained in the main FEDn Git repository.
The following command clones the entire repository but you will only use the example:

.. code-block:: bash
Expand Down

0 comments on commit 5557489

Please sign in to comment.