Skip to content

Commit

Permalink
Fix CommonKeys docstring (Project-MONAI#8342)
Browse files Browse the repository at this point in the history
### Description

`CommonKeys()` docstring mentions `INFO` which doesn't exist. Instead
there is a `METADATA` field, so the docstring was updated accordingly.

### Types of changes
- [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).
- [ ] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [ ] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Bartosz Grabowski <[email protected]>
Co-authored-by: YunLiu <[email protected]>
  • Loading branch information
bartosz-grabowski and KumoLiu authored Feb 20, 2025
1 parent fb8c5bf commit b0ed253
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion monai/utils/enums.py
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ class CommonKeys(StrEnum):
`LABEL` is the training or evaluation label of segmentation or classification task.
`PRED` is the prediction data of model output.
`LOSS` is the loss value of current iteration.
`INFO` is some useful information during training or evaluation, like loss value, etc.
`METADATA` is some useful information during training or evaluation, like loss value, etc.
"""

Expand Down

0 comments on commit b0ed253

Please sign in to comment.