@@ -45,12 +45,14 @@ class AutoRunner:
4545 An interface for handling Auto3Dseg with minimal inputs and understanding of the internal states in Auto3Dseg.
4646 The users can run the Auto3Dseg with default settings in one line of code. They can also customize the advanced
4747 features Auto3Dseg in a few additional lines. Examples of customization include
48+
4849 - change cross-validation folds
4950 - change training/prediction parameters
5051 - change ensemble methods
5152 - automatic hyperparameter optimization.
5253
5354 The output of the interface is a directory that contains
55+
5456 - data statistics analysis report
5557 - algorithm definition files (scripts, configs, pickle objects) and training results (checkpoints, accuracies)
5658 - the predictions on the testing datasets from the final algorithm ensemble
@@ -92,6 +94,7 @@ class AutoRunner:
9294 - User can also save the input dictionary as a input YAML file and use the following one-liner
9395
9496 .. code-block:: bash
97+
9598 python -m monai.apps.auto3dseg AutoRunner run --input=./input.yaml
9699
97100 - User can specify work_dir and data source config input and run AutoRunner:
@@ -159,7 +162,8 @@ class AutoRunner:
159162 runner.run()
160163
161164 Notes:
162- Expected results in the work_dir as below.
165+ Expected results in the work_dir as below::
166+
163167 work_dir/
164168 ├── algorithm_templates # bundle algo templates (scripts/configs)
165169 ├── cache.yaml # Autorunner will automatically cache results to save time
@@ -170,6 +174,7 @@ class AutoRunner:
170174 ├── segresnet_0 # network scripts/configs/checkpoints and pickle object of the algo
171175 ├── segresnet2d_0 # network scripts/configs/checkpoints and pickle object of the algo
172176 └── swinunetr_0 # network scripts/configs/checkpoints and pickle object of the algo
177+
173178 """
174179
175180 def __init__ (
@@ -360,9 +365,10 @@ def set_prediction_params(self, params: Optional[Dict[str, Any]] = None):
360365
361366 Args:
362367 params: a dict that defines the overriding key-value pairs during prediction. The overriding method
363- is defined by the algo class.
368+ is defined by the algo class.
364369
365370 Examples:
371+
366372 For BundleAlgo objects, this set of param will specify the algo ensemble to only inference the first
367373 two files in the testing datalist {"file_slices": slice(0, 2)}
368374
@@ -377,6 +383,7 @@ def set_hpo_params(self, params: Optional[Dict[str, Any]] = None):
377383 Set parameters for the HPO module and the algos before the training. It will attempt to (1) override bundle
378384 templates with the key-value pairs in ``params`` (2) chagne the config of the HPO module (e.g. NNI) if the
379385 key is found to be one of:
386+
380387 - "trialCodeDirectory"
381388 - "trialGpuNumber"
382389 - "trialConcurrency"
@@ -417,7 +424,7 @@ def set_image_save_transform(self, kwargs):
417424
418425 Args:
419426 kwargs: image writing parameters for the ensemble inference. The kwargs format follows SaveImage
420- transform. For more information, check https://docs.monai.io/en/stable/transforms.html#saveimage .
427+ transform. For more information, check https://docs.monai.io/en/stable/transforms.html#saveimage .
421428
422429 """
423430
@@ -473,8 +480,8 @@ def _train_algo_in_sequence(self, history: List[Dict[str, Any]]):
473480
474481 Note:
475482 The final results of the model training will be written to all the generated algorithm's output
476- folders under the working directory. The results include the model checkpoints, a
477- progress.yaml, accuracies in CSV and a pickle file of the Algo object.
483+ folders under the working directory. The results include the model checkpoints, a
484+ progress.yaml, accuracies in CSV and a pickle file of the Algo object.
478485 """
479486 for task in history :
480487 for _ , algo in task .items ():
@@ -493,12 +500,13 @@ def _train_algo_in_nni(self, history):
493500
494501 Note:
495502 The final results of the model training will not be written to all the previously generated
496- algorithm's output folders. Instead, HPO will generate a new algo during the searching, and
497- the new algo will be saved under the working directory with a different format of the name.
498- For example, if the searching space has "learning_rate", the result of HPO will be written to
499- a folder name with original task name and the param (e.g. "dints_0_learning_rate_0.001").
500- The results include the model checkpoints, a progress.yaml, accuracies in CSV and a pickle
501- file of the Algo object.
503+ algorithm's output folders. Instead, HPO will generate a new algo during the searching, and
504+ the new algo will be saved under the working directory with a different format of the name.
505+ For example, if the searching space has "learning_rate", the result of HPO will be written to
506+ a folder name with original task name and the param (e.g. "dints_0_learning_rate_0.001").
507+ The results include the model checkpoints, a progress.yaml, accuracies in CSV and a pickle
508+ file of the Algo object.
509+
502510 """
503511 default_nni_config = {
504512 "trialCodeDirectory" : "." ,
0 commit comments