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

Small dysfunctions in User Guide #1068

Open
lchambon opened this issue Mar 27, 2024 · 1 comment
Open

Small dysfunctions in User Guide #1068

lchambon opened this issue Mar 27, 2024 · 1 comment
Labels
candidate an individual developer submits a work request to the team (extension proposal, bug, other request)

Comments

@lchambon
Copy link
Contributor

After reading the User Guide, here are some small dysfunctions spotted:

  • In User Documentation/Getting Started/Basic Example, in the paragraph “Basic Full Example (for jupyter-notebook)”: the title “Multilayer Perceptron in Pytorch: model training loop (same example as previous one but transposed to Fed-BioMed)” should be replaced by “Multilayer Perceptron in Pytorch: model training loop” and the title “Multilayer Perceptron in Fed-BioMed with Pytorch: model training loop” may be replaced by “Multilayer Perceptron in Fed-BioMed with Pytorch: model training loop (same example as previous one but transposed to Fed-BioMed)”.

  • In User Documentation/User Guide/Researcher, the page “Configuring Researcher” does not work

  • In User Documentation/User Guide/Researcher/Training Data: in the paragraph just before “Conclusion” there is written “for example”, and there is no example.

  • In User Documentation/User Guide/Researcher/Experiment, in figure 2: should we change the “MQTT” communication by “gRPC” ?

  • In User Documentation/User Guide/Researcher/Aggregation, in paragraph “Fed-BioMed Aggregators”: the link “tutorial” does not work.

  • In User Documentation/User Guide/Optimization, the following links do not work: “its Optimization facility”, “declearn Optimizers documentation”, “declearn’s Optimizers documentation”, “Advanced Optimizers tutorial”, “the tutorial related to the use of declearn’s Optimizers”

@lchambon lchambon added needs-triage a user opens an issue, that needs to be tagged appropriatly by the development team candidate an individual developer submits a work request to the team (extension proposal, bug, other request) and removed needs-triage a user opens an issue, that needs to be tagged appropriatly by the development team labels Mar 27, 2024
@ybouilla
Copy link
Contributor

ybouilla commented Apr 2, 2024

Hey, thanks for reporting. I will try to fix those while modifying the documentation for the new redesign of Experiment and Job classes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
candidate an individual developer submits a work request to the team (extension proposal, bug, other request)
Projects
None yet
Development

No branches or pull requests

2 participants