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.

Sign up for GitHub

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

Jump to bottom

Update Dice Metric Docs #8388

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

Update Dice Metric Docs #8388

wants to merge 5 commits into from
+135 −79

Conversation

ericspod
Copy link
Member

@ericspod ericspod commented Mar 12, 2025 •
edited
Loading

Fixes #8385.

Description

This updates the docstrings for the Dice metric classes and tweak some constructor parameter names to improve comprehension.

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

ericspod added 3 commits March 11, 2025 18:12
@ericspod
Updating docstrings
c9436fa 
Signed-off-by: Eric Kerfoot <[email protected]>
@ericspod
Updating docstrings
b11540b 
Signed-off-by: Eric Kerfoot <[email protected]>
@ericspod
Amending documentation and tests
5e066e2 
Signed-off-by: Eric Kerfoot <[email protected]>
@KumoLiu
Copy link
Contributor

KumoLiu commented Mar 13, 2025

/build

KumoLiu
KumoLiu approved these changes Mar 20, 2025
View reviewed changes
Copy link
Contributor

@KumoLiu KumoLiu left a comment

Choose a reason for hiding this comment

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

LGTM.
@virginiafdez, do you have any comments on this one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KumoLiu KumoLiu KumoLiu approved these changes

@virginiafdez virginiafdez Awaiting requested review from virginiafdez

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Dice Metric/Loss Documentation
2 participants
@ericspod @KumoLiu