Skip to content

Commit

Permalink
Docs/SK-956 | Update docs to include new CLI entrypoints commands (#694)
Browse files Browse the repository at this point in the history
  • Loading branch information
sowmyasris authored Sep 6, 2024
1 parent dbf68e3 commit bdb9e9e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,15 @@ Then, standing inside the 'client folder', you can test *train* and *validate* b
python train.py ../seed.npz ../model_update.npz --data_path data/clients/1/mnist.pt
python validate.py ../model_update.npz ../validation.json --data_path data/clients/1/mnist.pt
You can also test *train* and *validate* entrypoint using CLI command:

.. note:: Before running the fedn run train or fedn run validate commands, make sure to download the training and test data. The downloads are usually handled by the "fedn run startup" command in the examples provided by FEDn.

.. code-block:: bash
fedn run train --path client --input <path to input model parameters> --output <path to write the updated model parameters>
fedn run validate --path client --input <path to input model parameters> --output <path to write the output JSON containing validation metrics>
Packaging for training on FEDn
===============================

Expand Down

0 comments on commit bdb9e9e

Please sign in to comment.