Skip to content

Commit 6eed10d

Browse files
committed
update docstring
Signed-off-by: YunLiu <[email protected]>
1 parent 6b2817e commit 6eed10d

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

monai/bundle/workflows.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,14 @@ class BundleWorkflow(ABC):
4444
workflow_type: specifies the workflow type: "train" or "training" for a training workflow,
4545
or "infer", "inference", "eval", "evaluation" for a inference workflow,
4646
other unsupported string will raise a ValueError.
47-
default to `train` for train workflow.
47+
default to `None` for only using meta properties.
4848
workflow: specifies the workflow type: "train" or "training" for a training workflow,
4949
or "infer", "inference", "eval", "evaluation" for a inference workflow,
5050
other unsupported string will raise a ValueError.
5151
default to `None` for common workflow.
52-
properties_path: the path to the JSON file of properties.
52+
properties_path: the path to the JSON file of properties. If workflow type is specified, the properties
53+
will be loaded from the file based on the workflow type and meta, otherwise, the properties will be loaded from
54+
"train". If the file does not exist, the default properties will be used.
5355
meta_file: filepath of the metadata file, if this is a list of file paths, their contents will be merged in order.
5456
logging_file: config file for `logging` module in the program. for more details:
5557
https://docs.python.org/3/library/logging.config.html#logging.config.fileConfig.
@@ -250,12 +252,14 @@ class PythonicWorkflow(BundleWorkflow):
250252
workflow_type: specifies the workflow type: "train" or "training" for a training workflow,
251253
or "infer", "inference", "eval", "evaluation" for a inference workflow,
252254
other unsupported string will raise a ValueError.
253-
default to `train` for train workflow.
255+
default to `None` for only using meta properties.
254256
workflow: specifies the workflow type: "train" or "training" for a training workflow,
255257
or "infer", "inference", "eval", "evaluation" for a inference workflow,
256258
other unsupported string will raise a ValueError.
257259
default to `None` for common workflow.
258-
properties_path: the path to the JSON file of properties.
260+
properties_path: the path to the JSON file of properties. If workflow type is specified, the properties
261+
will be loaded from the file based on the workflow type and meta, otherwise, the properties will be loaded from
262+
"train". If the file does not exist, the default properties will be used.
259263
config_file: path to the config file, typically used to store hyperparameters.
260264
meta_file: filepath of the metadata file, if this is a list of file paths, their contents will be merged in order.
261265
logging_file: config file for `logging` module in the program. for more details:

0 commit comments

Comments
 (0)