-
Notifications
You must be signed in to change notification settings - Fork 801
Add 3D segmentation calibration tutorial #2072
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
Open
theo-barfoot
wants to merge
2
commits into
Project-MONAI:main
Choose a base branch
from
theo-barfoot:feature/calibration-tutorial
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Segmentation model calibration | ||
|
|
||
| This folder contains a self-contained tutorial for evaluating and improving the marginal class-wise calibration of | ||
| semantic segmentation models. It trains on complete 3D volumes from the Medical Segmentation Decathlon | ||
| `Task04_Hippocampus` MRI dataset. The notebook downloads the approximately 28 MB archive automatically and reuses | ||
| the directory configured by `MONAI_DATA_DIRECTORY`. | ||
|
|
||
| The notebook demonstrates MONAI's calibration metrics, low-level bin statistics, Ignite handler, and hard- and | ||
| soft-binned L1 Average Calibration Error losses. It uses complete-volume train/validation/test cohorts and compares | ||
| a segmentation baseline with one hard L1-ACE configuration chosen in validation-only preliminary experiments for | ||
| its calibration improvement with minimal Dice reduction. The focused comparison discusses the associated | ||
| publication's 1:1:1 objective, finite-bin estimates, and the limitations of auxiliary calibration training. | ||
|
|
||
| For a one-epoch CI smoke test, run: | ||
|
|
||
| ```bash | ||
| export MONAI_DATA_DIRECTORY=/path/to/persistent/monai-data | ||
| ./runner.sh -t calibration/segmentation_calibration.ipynb | ||
| ``` | ||
|
|
||
| `runner.sh` rewrites `max_epochs` and `val_interval` to one. To reproduce the saved full experiment, open the notebook | ||
| in Jupyter and run all cells without that rewrite. A CUDA GPU is strongly recommended for the two 3D training runs. | ||
|
|
||
| The notebook requires a MONAI build containing `HardL1ACELoss` and `SoftL1ACELoss`. Until those APIs are available in | ||
| an official MONAI package, run it in an environment with the corresponding MONAI core contribution installed editable. | ||
Large diffs are not rendered by default.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Document the tutorial's actual loss ratio.
The text names the publication's
1:1:1objective but does not state that this tutorial uses the validation-selected1:1:0.30Dice:CE:Hard-L1-ACE objective. This can confuse reproduction of the reported results.Proposed wording
🤖 Prompt for AI Agents