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

Update documentation with new Fed-BioMed CLI usage #1254

Open
11 tasks done
Tracked by #1224
srcansiz opened this issue Dec 3, 2024 · 1 comment
Open
11 tasks done
Tracked by #1224

Update documentation with new Fed-BioMed CLI usage #1254

srcansiz opened this issue Dec 3, 2024 · 1 comment
Labels
in review issue implementation is finished, a merge request open and is ready for review (or under review) sprint backlog the development team adds an entry to the sprint backlog

Comments

@srcansiz
Copy link
Member

srcansiz commented Dec 3, 2024

Replace fedbiomed_run with fedbiomed

  • Component/config specification has changed to --path from --config. This requires to update documentation to have correct CLI usage.
  • Fed-BioMed now stores component files in a specific directory rather than ROOT Fed-BioMed directory
    - [ ] Fed-BioMed root to Fed-BioMed library source
    - [ ] or Fed-BioMed root to Fed-BioMed component root/ node installation directory
    - [ ] There is no environment cleaning script anymore. Removing component folder will clean the environment.
  • fedbiomed CLI creates folders for per component created instead of creating config files and using Fed-BioMed source directory as root directory. This requires to update documentation:
    • Replace creating a new node config with create a new node or create a new component
    • Explain component creation logic that --path can be absolute or relative path to the component folder.

The points above have been completed for getting started and partially for user guide. Same changes has to be done in tutorials

  • (SC) User guide
  • (YB) Tutorials pytorch
  • (YB) Tutorials advanced
  • Tutorials security
  • Tutorials scikit-learn
  • Tutorials others (YB-Flamby)
@srcansiz srcansiz added sprint backlog the development team adds an entry to the sprint backlog to do issue not started yet (but intention to start soon) labels Dec 3, 2024
@mvesin mvesin added doing issue implementation in progress and removed to do issue not started yet (but intention to start soon) labels Dec 20, 2024
@ybouilla ybouilla added in review issue implementation is finished, a merge request open and is ready for review (or under review) and removed doing issue implementation in progress labels Jan 20, 2025
@ybouilla
Copy link
Contributor

Completed documentation. Only concrete-ml tutorial is left untouched because of versioning issue (see related github issue).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in review issue implementation is finished, a merge request open and is ready for review (or under review) sprint backlog the development team adds an entry to the sprint backlog
Projects
None yet
Development

No branches or pull requests

3 participants