Docs/add studio to readme #549
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
Updates the main readme with information on how to get started with FEDn Studio.
ahellander
requested review from
niklastheman,
Wrede,
sztoor and
stefanhellander
sztoor
reviewed
Mar 19, 2024
There was a problem hiding this comment.
Overall, good and clear description.
For the part "Develop a FEDn project in a local development environment, and then deploy it to FEDn Studio"
We can make two branches:
1 - FL Data Scientist path -> All-in-one to more FEDn SDK
2 - FL Production FL -> All-in-one to FEDn Studio
Strong points of this approach:
- Will show the depth
- Make it more clear based on the different roles
Weak points of this approach:
- May be confusing and lengthy
niklastheman
approved these changes
Mar 19, 2024
There was a problem hiding this comment.
I think it's a good improvement!
A couple of thoughts though:
- Maybe we should get rid of the top logo in favor of the new one (we could perhaps "draw" it our selfs in the README to make it look "tech")? Also the logos (contributions) in the bottom could be better arranged and the Scaleout one is old...
- Do we need to mention Pytorch in the Quickstart section or could it simply say Getting started or Quickstart? Also I am still not thrilled about the term SDK. For med FEDn is first and foremost a framework.
- The link to the FEDn Studio docs will change soon. Don't have to wait for it though...
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
Add more information about FEDn Studio to main readme.