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 for extending optimizer and schedulers #764

Merged
merged 4 commits into from
Jan 11, 2024

Conversation

scap3yvt
Copy link
Collaborator

Fixes #N.A.

Proposed Changes

  • general-purpose documentation that provides clarity

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.
  • 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].

Copy link
Contributor

github-actions bot commented Jan 11, 2024

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

sarthakpati
sarthakpati previously approved these changes Jan 11, 2024
Copy link
Collaborator

@sarthakpati sarthakpati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@scap3yvt scap3yvt changed the title Added documentation for extending optimizer submodule Added documentation for extending optimizer and schedulers Jan 11, 2024
@sarthakpati sarthakpati self-requested a review January 11, 2024 13:58
Copy link
Collaborator

@sarthakpati sarthakpati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

codecov bot commented Jan 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b3dc6fa) 94.68% compared to head (7ee7409) 94.67%.
Report is 1 commits behind head on master.

❗ Current head 7ee7409 differs from pull request most recent head d9571cb. Consider uploading reports for the commit d9571cb to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #764      +/-   ##
==========================================
- Coverage   94.68%   94.67%   -0.02%     
==========================================
  Files         117      117              
  Lines        8242     8242              
==========================================
- Hits         7804     7803       -1     
- Misses        438      439       +1     
Flag Coverage Δ
unittests 94.67% <ø> (-0.02%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sarthakpati sarthakpati merged commit c6a42a8 into master Jan 11, 2024
22 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 11, 2024
@scap3yvt scap3yvt deleted the scap3yvt-patch-1 branch January 12, 2024 19:35
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.

2 participants