Project-MONAI / Project-MONAI/model-zoo

support of requirement specifiers

Open
#451 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature request
Dominant language
Python
Stars
338
Forks
106
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
The current metadata format supports specific versions of dependencies:
https://github.com/Project-MONAI/model-zoo/blob/ff6175a18bda80c2093cd6fb2a493055cccacf70/models/brats_mri_segmentation/configs/metadata.json#L28-L30

would be great to extend the syntax to have more flexibility such as https://pip.pypa.io/en/stable/reference/requirement-specifiers/#requirement-specifiers

this will require more testing pipelines and maintenance efforts, so the ci/cd config and contributing guide should also be revised accordingly.

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

Start with the linked models/brats_mri_segmentation/configs/metadata.json dependency entries and compare the requested syntax with pip's requirement specifiers documentation. Then review the CI/CD configuration and contributing guide to identify the testing and maintenance updates. Done means supported specifiers are tested and the CI/CD guidance and contributing instructions are revised.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, documentation, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.