Highlighting the difference between client node and training client. #583
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
Wrede
requested changes
Apr 23, 2024
| @@ -19,6 +19,11 @@ Start by creating an account in FEDn Studio and set up a project by following th | |||
| Install FEDn | |||
| ------------ | |||
|
|
|||
| Client node: A physical or virtual machine (MacOSx Linux or Windows) used to perform initial steps. | |||
There was a problem hiding this comment.
this just makes it more complex for the user I think, Also, it sound to much "hadoop"
| @@ -41,17 +46,18 @@ It is recommended to use a virtual environment when installing FEDn. | |||
|
|
|||
| .. _package-creation: | |||
|
|
|||
| Initialize FEDn with the client code bundle and seed model | |||
| Initialize FEDn with the compute package and seed model | |||
There was a problem hiding this comment.
We want to move away from calling it compute package and instead refer to is as a FEDn project which can be bundled into a package which then can be used by the fedn package manager.
| code that contains entrypoints for training and (optionally) validating a model update on the client. | ||
|
|
||
| [!NOTE] The preparation of the compute package and seed model is a one-time requirement. All training clients use the same compute package and seed model. |
| Locate into ``examples/mnist-pytorch`` and familiarize yourself with the project structure. The dependencies needed in the client environment are specified | ||
| in ``client/python_env.yaml``. | ||
|
|
||
| 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 bundle | ||
| of the client specification, and the seed model is a first version of the global 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 bundle of the client specification, and the seed model is a first version of the global model. |
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