Skip to content
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

Merged
merged 2 commits into from
Nov 18, 2024

Conversation

teoparvanov
Copy link
Collaborator

@teoparvanov teoparvanov commented Nov 15, 2024

Some of the resources and terminology having become outdated, I propose a refresh of the OpenFL main README!

Copy link
Collaborator

@MasterSkepticista MasterSkepticista left a 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:
Copy link
Collaborator

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 :)

Copy link
Collaborator Author

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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MasterSkepticista
Copy link
Collaborator

@teoparvanov Please also sneak this in if possible: #1119

Copy link
Collaborator

@kta-intel kta-intel left a 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

README.md Show resolved Hide resolved
@teoparvanov
Copy link
Collaborator Author

teoparvanov commented Nov 18, 2024

@teoparvanov Please also sneak this in if possible: #1119

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]>
@teoparvanov teoparvanov force-pushed the update-main-readme branch 4 times, most recently from 6d8c97a to 6854704 Compare November 18, 2024 09:03
Signed-off-by: Teodor Parvanov <[email protected]>
@teoparvanov teoparvanov merged commit 1929860 into securefederatedai:develop Nov 18, 2024
29 checks passed
@teoparvanov teoparvanov deleted the update-main-readme branch November 18, 2024 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants