Skip to content

400 Add example in the doc-string of Metric#3139

Merged
Nic-Ma merged 10 commits intoProject-MONAI:devfrom
Nic-Ma:enhance-metric-example
Oct 18, 2021
Merged

400 Add example in the doc-string of Metric#3139
Nic-Ma merged 10 commits intoProject-MONAI:devfrom
Nic-Ma:enhance-metric-example

Conversation

@Nic-Ma
Copy link
Copy Markdown
Contributor

@Nic-Ma Nic-Ma commented Oct 15, 2021

Description

According to Project-MONAI/tutorials#400, this PR added a short example in the doc-string of Metric to show the basic logic.

Status

Ready

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.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Oct 15, 2021

/black

@Nic-Ma Nic-Ma requested review from ericspod, rijobro and wyli October 15, 2021 15:23
@wyli
Copy link
Copy Markdown
Contributor

wyli commented Oct 17, 2021

/build

Copy link
Copy Markdown
Contributor

@wyli wyli left a comment

Choose a reason for hiding this comment

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

Thanks, might be useful to explain the use case (computing averaged dice over classes and iterations?) Or put a link of the metric tutorial.

@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Oct 18, 2021

Thanks, might be useful to explain the use case (computing averaged dice over classes and iterations?) Or put a link of the metric tutorial.

Sure, added in the latest commit.

Thanks.

@Nic-Ma Nic-Ma enabled auto-merge (squash) October 18, 2021 08:37
@wyli
Copy link
Copy Markdown
Contributor

wyli commented Oct 18, 2021

/build

@Nic-Ma Nic-Ma merged commit 467138f into Project-MONAI:dev Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants