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

docs(framework) Fix typos on the FL Tutorial documentation #4474

Merged
merged 3 commits into from
Nov 11, 2024

Conversation

dstripelis
Copy link
Contributor

Issue

Minor fixes and paraphrases of the Flower documentation in the Federated Learning tutorial page: https://flower.ai/docs/framework/tutorial-series-what-is-federated-learning.html#What-is-Federated-Learning?

Description

  • Fixing some syntactic and grammatical errors.
  • Capitalizing all headers.
  • Rephrasing some sentences to improve context.

Related issues/PRs

None

Proposal

Proposing grammatical and syntactical changes in the content of the What is Federated Learning? tutorial webpage to improve readability.

Explanation

  • Changed Classic Machine Learning to Classical Machine Learning.
  • Changed classic to classical wherever appropriate.
  • Changed Central machine learning to centralized machine learning.
  • Changed federated learning to Federated Learning in headers and when the term is introduced for the first time.
  • Changed at zero to from zero.
  • Added period at the end of the itemized list of where centralized machine learning is being used.
  • Changed artificial intelligence to machine learning given that machine learning fits better in the current context when comparing centralized to federated learning.
  • Added located when referring to a server.
  • Capitalized headers Federated Evaluation, Federated Analytics, Final Remarks

Checklist

  • Implement proposed change
  • Write tests
  • Update documentation
  • Make CI checks pass
  • Ping maintainers on Slack (channel #contributions)

Any other comments?

None

@dstripelis dstripelis changed the title docs(framework): Fix typos on the FL Tutorial documentation. docs(framework) Fix typos on the FL Tutorial documentation. Nov 11, 2024
@dstripelis dstripelis changed the title docs(framework) Fix typos on the FL Tutorial documentation. docs(framework): Fix typos on the FL Tutorial documentation Nov 11, 2024
@dstripelis dstripelis changed the title docs(framework): Fix typos on the FL Tutorial documentation docs(framework) Fix typos on the FL Tutorial documentation Nov 11, 2024
@danieljanes danieljanes enabled auto-merge (squash) November 11, 2024 17:39
@danieljanes danieljanes merged commit be65db4 into main Nov 11, 2024
54 of 55 checks passed
@danieljanes danieljanes deleted the doc-fltutorial-typo-fix branch November 11, 2024 17:45
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.

2 participants