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 a script to generate information useful for debugging #803

Conversation

scap3yvt
Copy link
Collaborator

Fixes #802

Proposed Changes

  • added a gandlf_debugInfo script to generate relevant debugging information
  • updated bug report template to refer to this file
  • made a common function to extract git hash information

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 Feb 16, 2024

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

sarthakpati
sarthakpati previously approved these changes Feb 16, 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

@sarthakpati sarthakpati mentioned this pull request Feb 16, 2024
10 tasks
Copy link

codecov bot commented Feb 16, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (3af7fff) 95.05% compared to head (94d13ec) 95.04%.
Report is 8 commits behind head on master.

Files Patch % Lines
GANDLF/utils/generic.py 71.42% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #803      +/-   ##
==========================================
- Coverage   95.05%   95.04%   -0.02%     
==========================================
  Files         119      119              
  Lines        8287     8288       +1     
==========================================
  Hits         7877     7877              
- Misses        410      411       +1     
Flag Coverage Δ
unittests 95.04% <80.00%> (-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 8b1f881 into mlcommons:master Feb 16, 2024
19 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 16, 2024
@scap3yvt scap3yvt deleted the 802-add-a-script-to-generate-information-useful-for-debugging branch March 21, 2024 13:54
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 a script to generate information useful for debugging
2 participants