Skip to content

6398 Improve check and error message of bundle run #6400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 19, 2023
Merged

6398 Improve check and error message of bundle run #6400

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
42a45e0
Merge pull request #19 from Project-MONAI/master
Nic-Ma Feb 1, 2021
cd16a13
Merge pull request #32 from Project-MONAI/master
Nic-Ma Feb 24, 2021
6f87afd
Merge pull request #180 from Project-MONAI/dev
Nic-Ma Jul 22, 2021
f398298
Merge pull request #214 from Project-MONAI/dev
Nic-Ma Sep 8, 2021
ec463d6
Merge pull request #397 from Project-MONAI/dev
Nic-Ma Apr 4, 2022
ca62306
Merge pull request #429 from Project-MONAI/dev
Nic-Ma Jul 8, 2022
6b63f3e
Merge branch 'Project-MONAI:main' into main
Nic-Ma Jan 11, 2023
dee831b
Merge pull request #466 from Project-MONAI/dev
Nic-Ma Apr 19, 2023
2d08fb5
[DLMED] add error message
Nic-Ma Apr 19, 2023
d102770
[DLMED] add test
Nic-Ma Apr 19, 2023
e18d584
[DLMED] add doc-string
Nic-Ma Apr 19, 2023
024db64
[DLMED] fix CI test
Nic-Ma Apr 19, 2023
99d0cb1
[DLMED] update according to comments
Nic-Ma Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions monai/bundle/scripts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,8 +625,11 @@ def run(

Args:
run_id: ID name of the expected config expression to run, default to "run".
to run the config, the target config must contain this ID.
init_id: ID name of the expected config expression to initialize before running, default to "initialize".
allow a config to have no `initialize` logic and the ID.
final_id: ID name of the expected config expression to finalize after running, default to "finalize".
allow a config to have no `finalize` logic and the ID.
meta_file: filepath of the metadata file, if it is a list of file paths, the content of them will be merged.
Default to "configs/metadata.json", which is commonly used for bundles in MONAI model zoo.
config_file: filepath of the config file, if `None`, must be provided in `args_file`.
Expand Down
5 changes: 5 additions & 0 deletions monai/bundle/workflows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,11 @@ class ConfigWorkflow(BundleWorkflow):

Args:
run_id: ID name of the expected config expression to run, default to "run".
to run the config, the target config must contain this ID.
init_id: ID name of the expected config expression to initialize before running, default to "initialize".
allow a config to have no `initialize` logic and the ID.
final_id: ID name of the expected config expression to finalize after running, default to "finalize".
allow a config to have no `finalize` logic and the ID.
meta_file: filepath of the metadata file, if it is a list of file paths, the content of them will be merged.
Default to "configs/metadata.json", which is commonly used for bundles in MONAI model zoo.
config_file: filepath of the config file, if it is a list of file paths, the content of them will be merged.
Expand Down Expand Up @@ -235,6 +238,8 @@ def run(self) -> Any:
Run the bundle workflow, it can be a training, evaluation or inference.

"""
if self.run_id not in self.parser:
raise ValueError(f"run ID '{self.run_id}' doesn't exist in the config file.")
return self._run_expr(id=self.run_id)

def finalize(self) -> Any:
Expand Down
3 changes: 3 additions & 0 deletions tests/test_integration_bundle_run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ def test_tiny(self):
# test both CLI entry "run" and "run_workflow"
command_line_tests(cmd + ["run", "training", "--config_file", config_file])
command_line_tests(cmd + ["run_workflow", "--run_id", "training", "--config_file", config_file])
with self.assertRaises(RuntimeError):
# test wrong run_id="run"
command_line_tests(cmd + ["run", "run", "--config_file", config_file])

@parameterized.expand([TEST_CASE_1, TEST_CASE_2])
def test_shape(self, config_file, expected_shape):
Expand Down