Skip to content

Conversation

@sarthakpati
Copy link
Collaborator

Fixes #937

Proposed Changes

  • added dedicated section for ITCR connectivity map

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.

@sarthakpati sarthakpati requested a review from a team as a code owner September 11, 2024 19:55
@sarthakpati sarthakpati linked an issue Sep 11, 2024 that may be closed by this pull request
@github-actions
Copy link
Contributor

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

@codecov
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.62%. Comparing base (f3cdff8) to head (19b7178).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #938      +/-   ##
==========================================
+ Coverage   94.61%   94.62%   +0.01%     
==========================================
  Files         161      161              
  Lines        9561     9561              
==========================================
+ Hits         9046     9047       +1     
+ Misses        515      514       -1     
Flag Coverage Δ
unittests 94.62% <ø> (+0.01%) ⬆️

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.

Copy link
Collaborator

@szmazurek szmazurek 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 merged commit 5944c6a into master Sep 11, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Sep 11, 2024
@sarthakpati sarthakpati deleted the 937-feature-add-documentation-related-to-itcr-connectivity-map branch September 11, 2024 22:12
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 related to ITCR connectivity map

3 participants