Skip to content

4540 Add example in the doc of metrics#4660

Merged
Nic-Ma merged 10 commits intoProject-MONAI:devfrom
Nic-Ma:4540-add-metric-example
Jul 11, 2022
Merged

4540 Add example in the doc of metrics#4660
Nic-Ma merged 10 commits intoProject-MONAI:devfrom
Nic-Ma:4540-add-metric-example

Conversation

@Nic-Ma
Copy link
Copy Markdown
Contributor

@Nic-Ma Nic-Ma commented Jul 8, 2022 •
edited
Loading

Fixes #4540 .

Description

This PR added the typical usage example in the doc-string of metrics.

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

@Nic-Ma Nic-Ma changed the title [WIP] 4540 Add example in the doc of metrics 4540 Add example in the doc of metrics Jul 11, 2022
@Nic-Ma Nic-Ma marked this pull request as ready for review July 11, 2022 09:00
@Nic-Ma Nic-Ma requested review from ericspod, rijobro and wyli July 11, 2022 09:01
@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Jul 11, 2022

/black

@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Jul 11, 2022

/build

wyli
wyli approved these changes Jul 11, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@wyli wyli left a comment •
edited
Loading

Choose a reason for hiding this comment

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

the approach looks good to me, it seems you forget to update https://github.com/Project-MONAI/MONAI/blob/dev/monai/metrics/meaniou.py

@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Jul 11, 2022

/black

@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Jul 11, 2022

/build

@Nic-Ma Nic-Ma enabled auto-merge (squash) July 11, 2022 15:44
@Nic-Ma Nic-Ma merged commit f84a908 into Project-MONAI:dev Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wyli wyli wyli approved these changes

@ericspod ericspod Awaiting requested review from ericspod ericspod is a code owner

@rijobro rijobro Awaiting requested review from rijobro

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Nic-Ma @wyli