Docs/SK-924 | Update quickstart guide #648
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
niklastheman
reviewed
Jul 2, 2024
There was a problem hiding this comment.
I have some thoughts:
- I think the "Getting started with FEDn" section should be under "Introduction".
- I think using the Studio interface should be present in the "Getting started with FEDn" guide. Then, of course we can include a short line on how to achieve the same result using the cli.
- Running the client in the "Getting started with FEDn" example is still done via docker.
- I would prefer if the "Getting started with FEDn" guide did not make use of the mnist-pytorch example but instead took the reader through creating their own FEDn project. (perhaps could be done later)
niklastheman
reviewed
Jul 5, 2024
docs/quickstart.rst
Outdated
|
|
||
| .. code:: python | ||
|
|
||
| >>> ... | ||
| >>> client.download_model("<model-id>", path="model.npz") | ||
|
|
||
|
|
||
| **Connecting clients using Docker** | ||
| Connecting clients using Docker |
There was a problem hiding this comment.
Are we sure this is needed in the "Getting started" section?
Wrede
reviewed
Jul 9, 2024
Wrede
reviewed
Jul 9, 2024
docs/quickstart.rst
Outdated
|
|
||
| git clone https://github.com/scaleoutsystems/fedn.git | ||
|
|
||
| Locate into ``examples/mnist-pytorch`` folder. The compute package is located in the folder ``client``. |
There was a problem hiding this comment.
should be "fedn/examples/mnist-pytorch"
Wrede
approved these changes
Jul 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
https://fedn.readthedocs.io/en/docs-sk-924/quickstart.html
Starts implementing the Docs updates we discussed: