-
Notifications
You must be signed in to change notification settings - Fork 36
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. But are you sure fedn train works this way for the mnist-pytorch example, I wonder about --data-path
Yes, If there is no --data-path, it picks from environment variable FEDN_DATA_PATH
|
--data-path is specific for mnist examples. FEDn is not keep track of use-cases data, user have to make sure the training (and test) data is loaded in for whatever command is defined in train entrypoint. So, for mnist examples fedn run startup (to download the data, path will default to "/data/clients/1/mnist.pt" for torch for example ) needs to be run before fedn run train |
you can add a note for this in the docs "Please observe that many of the fedn examples requires you to first download the training and test data before you run "fedn run train/validate" entrypoints. The downloads are usually handled by the "fedn run startup" command " |
Update the documentation with new CLI entrypoint commands