Improve Syntax of Sigils #6721
Assignees
Labels
Comments
|
How about |
|
Although ":" is used in slicing I think it would be clear here that the use is different. "^" and "^^" are used for changing case in bash so that might conflict. I would also avoid "|" since this is pipe in bash. Perhaps "!" wouldn't conflict with anything? It might well be possible to use "." as a separator, it would mean either member access in place of "#" or what "." means normally and it would be up to the parser to tell them apart. |
|
Follow-up of our previous discussions, the syntax change from One way to make it backward compatible is to provide a system environment variable #6952 (by default it's non-breaking) I think we should have another discussion about how to proceed. Please see a list of related code to this syntax change: |
|
I'd suggest that we make |
it's also feasible to use |
wyli
added a commit
that referenced
this issue
Sep 8, 2023
fixes #6721 ### Description compatible syntax by normalising any `#` in ids to `::` ```py from monai.bundle import ConfigParser config = { "my_dims": 2, "dims_1": "$@my_dims + 1", "my_net": {"_target_": "BasicUNet", "spatial_dims": "@dims_1", "in_channels": 1, "out_channels": 4}, } # in the example $@my_dims + 1 is an expression, which adds 1 to the value of @my_dims parser = ConfigParser(config) print(parser.get_parsed_content("my_net::spatial_dims")) # returns 3 print(parser.get_parsed_content("my_net#spatial_dims")) # returns 3 ``` new test cases: https://github.com/Project-MONAI/MONAI/blob/66b50fb8384ae2dc3c76b39de673ce76908f94f2/tests/test_config_parser.py#L317-L321 ### 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). - [x] New tests added to cover the changes. - [x] 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: Wenqi Li <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Using the # character as a sigil or separator is slightly cumbersome because it's also the comment character in Python and Bash. Values mentioned on the command line need to be put in quotes, eg.
'--trainer#max_epochs' 5. Perhaps deprecating this and using : or :: instead?MONAI/monai/bundle/utils.py
Lines 26 to 29 in 3b6b11a
The text was updated successfully, but these errors were encountered: