Project-MONAI / Project-MONAI/MONAI

`properties_path` of `BundleWorkflow` only support json format

Open
#8,166 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.7k
Forks
1.6k
Avg merge
5d 1h
Merged PRs (30d)
20

Description

It's different from the default setting: using a .py file to save properties:
https://github.com/Project-MONAI/MONAI/blob/684688a2877b07b0e1da98bb13f18a60ac73d426/monai/bundle/workflows.py#L51

For users that want to define a properties file, a simple way is to copy and modify the file: https://github.com/Project-MONAI/MONAI/blob/684688a2877b07b0e1da98bb13f18a60ac73d426/monai/bundle/properties.py

it's inconvenient to use json since it requires to manually "translate" ID_SEP_KEY, BundleProperty and BundlePropertyConfig.

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 by reading monai/bundle/workflows.py around the referenced BundleWorkflow configuration and compare it with monai/bundle/properties.py. Trace how properties_path is loaded and how the default Python properties file is represented. Done means users can provide a .py properties file without manually translating ID_SEP_KEY, BundleProperty, and BundlePropertyConfig into JSON.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.