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.

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

Conversation

sowmyasris
Copy link
Contributor

Update the documentation with new CLI entrypoint commands

Copy link
Member

@ahellander ahellander left a 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

@sowmyasris
Copy link
Contributor Author

sowmyasris commented Sep 4, 2024

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

if data_path is None:
    data_path = os.environ.get("FEDN_DATA_PATH", abs_path + "/data/clients/1/mnist.pt")
     which is in data.py file.

@Wrede
Copy link
Member

Wrede commented Sep 4, 2024

--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

@Wrede
Copy link
Member

Wrede commented Sep 4, 2024

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 "

@Wrede Wrede merged commit bdb9e9e into master Sep 6, 2024
8 checks passed
@Wrede Wrede deleted the Docs/SK-956 branch September 6, 2024 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants