Skip to content

2015 improve explanation of datalist format #2019

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

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

DanielNobbe
Copy link

@DanielNobbe DanielNobbe commented Aug 14, 2025

Fixes #2015 .

Description

Added explanation of datalist format for easier quick-start for new users interested in using the Auto3DSeg AutoRunner. Also simplified the datalist explanation in run_with_minimal_input.md, and specified that the msd_datalist_generator.ipynb notebook is only used to generate a datalist with cross-validation folds from an existing MSD dataset (and renamed it accordingly to msd_crossval_datalist_generator.ipynb).

New users landing on the main README of the Auto3DSeg tutorial will now directly see how to create a datalist for their own data, and can easily find where further steps are described.

I also removed a paragraph on epoch/iteration numbers from theauto_runner.ipynb that is no longer relevant since MONAI v1.1.

There is a corresponding PR here that contains improvements to the MONAI library with regards to the datalist format.

Checks

  • Avoid including large-size files in the PR.
  • Clean up long text outputs from code cells in the notebook.
  • For security purposes, please check the contents and remove any sensitive info such as user names and private key.
  • Ensure (1) hyperlinks and markdown anchors are working (2) use relative paths for tutorial repo files (3) put figure and graphs in the ./figure folder
  • Notebook runs automatically ./runner.sh -t <path to .ipynb file>

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

I, Daniël Nobbe <[email protected]>, hereby add my Signed-off-by to this commit: afce136
I, Daniël Nobbe <[email protected]>, hereby add my Signed-off-by to this commit: ffb501d
I, Daniël Nobbe <[email protected]>, hereby add my Signed-off-by to this commit: 5bf0ed6
I, Daniël Nobbe <[email protected]>, hereby add my Signed-off-by to this commit: 9e3d557
I, Daniël Nobbe <[email protected]>, hereby add my Signed-off-by to this commit: 79484f7

Signed-off-by: Daniël Nobbe <[email protected]>
@DanielNobbe DanielNobbe force-pushed the 2015-improve-explanation-of-datalist-format branch from 1a5afde to c969d10 Compare August 14, 2025 14:50
Signed-off-by: Daniël Nobbe <[email protected]>
@DanielNobbe DanielNobbe force-pushed the 2015-improve-explanation-of-datalist-format branch from bc51740 to 5106732 Compare August 14, 2025 14:53
@DanielNobbe DanielNobbe force-pushed the 2015-improve-explanation-of-datalist-format branch from 6025260 to 4cfa3f6 Compare August 14, 2025 14:57
Signed-off-by: Daniël Nobbe <[email protected]>
@DanielNobbe DanielNobbe force-pushed the 2015-improve-explanation-of-datalist-format branch from fb53523 to 8f3405a Compare August 14, 2025 14:58
Signed-off-by: Daniël Nobbe <[email protected]>
@DanielNobbe DanielNobbe force-pushed the 2015-improve-explanation-of-datalist-format branch from 6dd0e48 to c31841a Compare August 14, 2025 15:08
Signed-off-by: Daniël Nobbe <[email protected]>
@DanielNobbe DanielNobbe force-pushed the 2015-improve-explanation-of-datalist-format branch 2 times, most recently from 1657278 to 4bd67b7 Compare August 14, 2025 15:12
@DanielNobbe DanielNobbe force-pushed the 2015-improve-explanation-of-datalist-format branch from 5aafac2 to 24493b0 Compare August 15, 2025 15:18
KumoLiu pushed a commit to Project-MONAI/MONAI that referenced this pull request Aug 22, 2025
Fixes #8525 .

### Description

I found the description of the Medical Segmentation Decathlon datalist
format (short: decathlon datalist) lacking, although some parts of the
framework depend on it, specifically the Auto3DSeg AutoRunner.
I've added a comprehensive description of the format under
`monai.data.decathlon_datalist.load_decathlon_datalist`, and some small
notes elsewhere.

There's a corresponding PR for the tutorials
[here](Project-MONAI/tutorials#2019).

Please let me know if anything is incorrect, the codebase is quite big
and I haven't been working with it for very long.

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] 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`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [x] In-line docstrings updated.
- [x] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: Daniël Nobbe <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Eric Kerfoot <[email protected]>
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.

Improve explanation of datalist format
1 participant