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 on private model training #952

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

scap3yvt
Copy link
Collaborator

@scap3yvt scap3yvt commented Oct 1, 2024

Fixes #951

Proposed Changes

  • documentation on how someone can train private models has been added

Checklist

  • CONTRIBUTING guide has been followed.
  • PR is based on 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 (ensure typing is used to provide type hints, including and not limited to using Optional if a variable has a pre-defined value).
  • Code has been blacked for style consistency and linting.
  • 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.
  • 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].
  • The logging library is being used and no print statements are left.

@scap3yvt scap3yvt requested a review from a team as a code owner October 1, 2024 01:23
@scap3yvt scap3yvt linked an issue Oct 1, 2024 that may be closed by this pull request
Copy link
Contributor

github-actions bot commented Oct 1, 2024

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

@sarthakpati sarthakpati merged commit 1fc8ede into master Oct 1, 2024
23 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 1, 2024
@scap3yvt scap3yvt deleted the 951-feature-add-documentation-for-dp-training branch November 1, 2024 01:08
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.

[FEATURE] Add documentation for DP training
2 participants