Project-MONAI / Project-MONAI/tutorials

the argument needed to change the default directory in pathology/tumor_detection/README.MD

Open Beginner friendly
#1,704 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
2.5k
Forks
803
Avg merge
6d 22h
Merged PRs (30d)
3

Description

Describe the bug

In README.MD:

you can easily modify it to point to a different directory by passing the following argument in the runtime: --data-root /other/data/root/dir/

In .py files:

    parser.add_argument(
        "--root",
        type=str,
        default="/workspace/data/medical/pathology",
        help="path to image folder containing training/validation",
    )

“--data-root ” in README.MD should be changed to "--root" ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open pathology/tumor_detection/README.MD and compare its documented command-line argument with the parser.add_argument definition in the related .py files. Update the README to match the implemented data-directory option, then verify the usage example is consistent with the parser.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.