From 1c6d5b1cfc0232fa82cf5f80acddc5bd4847e98e Mon Sep 17 00:00:00 2001 From: YunLiu <55491388+KumoLiu@users.noreply.github.com> Date: Thu, 10 Oct 2024 11:06:28 +0800 Subject: [PATCH] Update readme in vista3d (#692) Update readme in vista3d regarding if input data missing header information ### Status **Ready/Work in progress/Hold** ### Please ensure all the checkboxes: - [x] Codeformat tests passed locally by running `./runtests.sh --codeformat`. - [ ] In-line docstrings updated. - [ ] Update `version` and `changelog` in `metadata.json` if changing an existing bundle. - [ ] Please ensure the naming rules in config files meet our requirements (please refer to: `CONTRIBUTING.md`). - [ ] Ensure versions of packages such as `monai`, `pytorch` and `numpy` are correct in `metadata.json`. - [ ] Descriptions should be consistent with the content, such as `eval_metrics` of the provided weights and TorchScript modules. - [ ] Files larger than 25MB are excluded and replaced by providing download links in `large_file.yml`. - [ ] Avoid using path that contains personal information within config files (such as use `/home/your_name/` for `"bundle_root"`). --------- Signed-off-by: YunLiu <55491388+KumoLiu@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- models/vista3d/configs/metadata.json | 3 ++- models/vista3d/docs/README.md | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/models/vista3d/configs/metadata.json b/models/vista3d/configs/metadata.json index 30904a97..285db4f2 100644 --- a/models/vista3d/configs/metadata.json +++ b/models/vista3d/configs/metadata.json @@ -1,7 +1,8 @@ { "schema": "https://github.com/Project-MONAI/MONAI-extra-test-data/releases/download/0.8.1/meta_schema_20240725.json", - "version": "0.5.2", + "version": "0.5.3", "changelog": { + "0.5.3": "update readme", "0.5.2": "fix eval issue", "0.5.1": "add description for zero-shot and upate eval", "0.5.0": "update json file link and add test", diff --git a/models/vista3d/docs/README.md b/models/vista3d/docs/README.md index d5fe7ca6..18a5971c 100644 --- a/models/vista3d/docs/README.md +++ b/models/vista3d/docs/README.md @@ -116,6 +116,9 @@ The default configs for both variables are derived from the `label_mappings` con "val_label_set": "$[0] + list(x[0] for x in @label_mappings#default)" ``` +Note: Please ensure the input data header is correct. The output file will use the same header as the input data, but if the input data is missing header information, MONAI will automatically provide some default values for missing values (e.g. `np.eye(4)` will be used if affine information is absent). This may cause a visualization misalignment depending on the visualization tool. + + ### Commands Single-GPU: