Docs/SK-958 | Improve docs #675
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
ahellander
changed the title
|
I have added a few comments. I think it will be better if we take out the APIClient instructions and make a separate quick stack for API-based communication. The one mentioned in this document will not work until we talk about tokens, URLs etc. I think it will cause confusion. |
added 11 commits
August 25, 2024 17:00
sztoor
approved these changes
Aug 28, 2024
|
|
||
| 2. Install FEDn on your client | ||
| ------------------------------- | ||
| First install the FEDn API on your local machine (client): |
|
|
||
| 3. Create the compute package and seed model | ||
| -------------------------------------------- | ||
| **Create the compute package and seed model** | ||
|
|
||
| In order to train a federated model using FEDn, your Studio project needs to be initialized with a ``compute package`` and a ``seed model``. The compute package is a code bundle containing the | ||
| code used by the client to execute local training and local validation. The seed model is a first version of the global model. |
There was a problem hiding this comment.
We need to give them the instructions to generate compute package and seed model:
Locate into the fedn/examples/mnist-pytorch folder.
fedn package create --path client
This will create a file called package.tgz in the root of the project.
Next, create the seed model:
fedn run build --path client
This will create a file called seed.npz in the root of the project.
ahellander
changed the title
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
This PR imroves the docs based on Salman's experiences from running the tutorial in the workshop.