Skip to content

_desc_ keyword in bundle for config readability #4958

@wyli

Description

@wyli

Is your feature request related to a problem? Please describe.
Although the bundle config can be yaml files which support inline commenting (starting a line with #), the json config couldn't include any comments or descriptions.
for example https://github.com/Project-MONAI/tutorials/blob/main/modules/bundle/spleen_segmentation/configs/inference.json is not very straightforward to understand.

This is a feature request for keyword _desc_, in addition to the existing ones

non_arg_keys = {"_target_", "_disabled_", "_requires_"}

so that the users can provide some free text comments without breaking the config components.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions