-
Notifications
You must be signed in to change notification settings - Fork 214
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
Updating the main README.md #1150
Updating the main README.md #1150
Conversation
5ba9f64
to
27e5c85
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for picking this up. I've added my suggestions as quotes so you can copy/paste/edit.
P.S: Support
section has an outdated 2022 line. Please remove that too.
README.md
Outdated
@@ -35,16 +35,16 @@ For more installation options check out the [online documentation](https://openf | |||
## Getting Started | |||
|
|||
|
|||
OpenFL enables data scientists to set up a federated learning experiment following one of the workflows: | |||
OpenFL enables data scientists to set up a federated learning experiment following one of the interfaces: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"OpenFL supports two APIs to set up a Federated Learning experiment:"?
We may want to reserve "interfaces" for something later :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added this, albeit a little rephrased.
@teoparvanov Please also sneak this in if possible: #1119 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Definitely time for a rework! Thanks a lot for taking this on @teoparvanov
I'm sure this will be an ongoing effort, but this is an excellent start to freshen things up
I suggest to treat this separately as it requires general rework, based on a more strategic perspective. It's on my TODO list already 😉! |
Signed-off-by: Teodor Parvanov <[email protected]>
6d8c97a
to
6854704
Compare
Signed-off-by: Teodor Parvanov <[email protected]>
6854704
to
16916bf
Compare
Some of the resources and terminology having become outdated, I propose a refresh of the OpenFL main README!