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

3405 Enhance doc-string of MIL model for data shape #3407

Merged
merged 9 commits into from
Nov 26, 2021

Conversation

Nic-Ma
Copy link
Contributor

@Nic-Ma Nic-Ma commented Nov 26, 2021

Fixes #3405 .

Description

This PR enhanced doc-string of MIL model to help users understand the expected data shape, like #3405 .

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
Contributor Author

Nic-Ma commented Nov 26, 2021

/black

@Nic-Ma
Copy link
Contributor Author

Nic-Ma commented Nov 26, 2021

/build

Signed-off-by: Nic Ma <nma@nvidia.com>
@Nic-Ma
Copy link
Contributor Author

Nic-Ma commented Nov 26, 2021

/build

@@ -11,6 +11,10 @@
class MILModel(nn.Module):
"""
Multiple Instance Learning (MIL) model, with a backbone classification model.
Currently, it only works for 2D images, typical use case is for classification of the
Copy link
Contributor

@wyli wyli Nov 26, 2021

Choose a reason for hiding this comment

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

looks like this model will be 2D only, the name MILModel is too generic and confusing cc @myron

@Nic-Ma Nic-Ma enabled auto-merge (squash) November 26, 2021 13:45
@Nic-Ma
Copy link
Contributor Author

Nic-Ma commented Nov 26, 2021

/build

Signed-off-by: Nic Ma <nma@nvidia.com>
@Nic-Ma
Copy link
Contributor Author

Nic-Ma commented Nov 26, 2021

/build

@Nic-Ma Nic-Ma merged commit 4a3db69 into Project-MONAI:dev Nov 26, 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.

3 participants