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

Added documentation related to OpenFL #683

Conversation

sarthakpati
Copy link
Collaborator

@sarthakpati sarthakpati commented Jun 29, 2023

Fixes #682

Proposed Changes

Checklist

  • I have read the CONTRIBUTING guide.
  • My PR is based from the current GaNDLF master .
  • Non-breaking change (does not break existing functionality): provide as many details as possible for any breaking change.
  • Function/class source code documentation added/updated.
  • Code has been blacked for style consistency.
  • If applicable, version information has been updated in GANDLF/version.py.
  • If adding a git submodule, add to list of exceptions for black styling in pyproject.toml file.
  • Usage documentation has been updated, if appropriate.
  • History has been updated, if appropriate.
  • Tests added or modified to cover the changes; if coverage is reduced, please give explanation.
  • If customized dependency installation is required (i.e., a separate pip install step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: python-test.yml, and all docker files [1,2,3].

@github-actions
Copy link
Contributor

github-actions bot commented Jun 29, 2023

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@sarthakpati sarthakpati marked this pull request as draft June 29, 2023 17:22
@sarthakpati sarthakpati mentioned this pull request Jun 29, 2023
11 tasks
@sarthakpati sarthakpati marked this pull request as ready for review June 29, 2023 18:06
@codecov
Copy link

codecov bot commented Jun 29, 2023

Codecov Report

Merging #683 (7a02223) into master (efb21e2) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #683   +/-   ##
=======================================
  Coverage   94.59%   94.59%           
=======================================
  Files         116      116           
  Lines        8017     8017           
=======================================
  Hits         7584     7584           
  Misses        433      433           
Flag Coverage Δ
unittests 94.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@sarthakpati sarthakpati requested a review from hasan7n July 3, 2023 12:51
@sarthakpati
Copy link
Collaborator Author

@Geeks-Sid Geeks-Sid merged commit e434b26 into mlcommons:master Jul 4, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jul 4, 2023
@hasan7n
Copy link
Contributor

hasan7n commented Jul 4, 2023

@sarthakpati looks good thanks!

@sarthakpati sarthakpati deleted the 682-add-documentation-describing-how-one-could-federate-their-models-using-openfl branch July 4, 2023 15:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation describing how one could federate their models using OpenFL
3 participants