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.

Sign up for GitHub

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/SK-956 | Update docs to include new CLI entrypoints commands #694

Merged
merged 6 commits into from
Sep 6, 2024
Merged

Docs/SK-956 | Update docs to include new CLI entrypoints commands #694

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c036dba
added documentation for using the CLI command for train and validate …
sowmyasris Aug 23, 2024
56259b5
Merge branch 'master' of https://github.com/scaleoutsystems/fedn into…
sowmyasris Sep 4, 2024
b006edb
Merge clean up
sowmyasris Sep 4, 2024
0ac7664
fixed the merge issue and order of commands
sowmyasris Sep 4, 2024
1f62f1a
added note brfore executing the entry points
sowmyasris Sep 5, 2024
3008ed8
Update projects.rst
Wrede Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/projects.rst
View file
Open in desktop
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
Loading