Skip to content

Commit f8239f9

Browse files
authored
Typo fix under auto3dseg folder (Project-MONAI#1706)
### Checks <!--- Put an `x` in all the boxes that apply, and remove the not applicable items --> - [ ] Avoid including large-size files in the PR. - [ ] Clean up long text outputs from code cells in the notebook. - [ ] For security purposes, please check the contents and remove any sensitive info such as user names and private key. - [ ] Ensure (1) hyperlinks and markdown anchors are working (2) use relative paths for tutorial repo files (3) put figure and graphs in the `./figure` folder - [ ] Notebook runs automatically `./runner.sh -t <path to .ipynb file>` --------- Signed-off-by: KumoLiu <[email protected]> Signed-off-by: YunLiu <[email protected]>
1 parent 179d3cd commit f8239f9

File tree

5 files changed

+8
-21
lines changed

5 files changed

+8
-21
lines changed

auto3dseg/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ We provide [a two-minute example](notebooks/auto3dseg_hello_world.ipynb) for use
5454

5555
## A "Real-World" Example
5656

57-
To further demonstrate the capabilities of **Auto3DSeg**, [here](tasks/instance22) is the detailed performance of the algorithm in **Auto3DSeg**, which won 2nd place in the MICCAI 2022 challenge** [INSTANCE22: The 2022 Intracranial Hemorrhage Segmentation Challenge on Non-Contrast Head CT (NCCT)](https://instance.grand-challenge.org/)**
57+
To further demonstrate the capabilities of **Auto3DSeg**, [here](./tasks/instance22/README.md) is the detailed performance of the algorithm in **Auto3DSeg**, which won 2nd place in the MICCAI 2022 challenge **[INSTANCE22: The 2022 Intracranial Hemorrhage Segmentation Challenge on Non-Contrast Head CT (NCCT)](https://instance.grand-challenge.org/)**
5858

5959
## Reference Python APIs for Auto3DSeg
6060

auto3dseg/docs/algorithm_generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The code block would generate multiple algorithm bundles as follows. The folder
6565

6666
### Algorithm Templates
6767

68-
The Python class **BundleGen** utilizes [the default algorithm templates](https://github.com/Project-MONAI/research-contributions/tree/main/auto3dseg) implicitly. The default algorithms are based on four established works (DiNTS, SegResNet, SegResNet2D, and SwinUNETR). They support both 3D CT and MR image segmentation. In the template, some items are empty or null, and they will be filled together with dataset information. The part of the configuration file "hyper_parameters.yaml" is shown below. In the configuration, the items (like "bundle_root", "data_file_base_dir", and "patch_size") will be filled up automatically with any user interaction.
68+
The Python class **BundleGen** utilizes [the default algorithm templates](https://github.com/Project-MONAI/research-contributions/tree/main/auto3dseg) implicitly. The default algorithms are based on four established works (DiNTS, SegResNet, SegResNet2D, and SwinUNETR). They support both 3D CT and MR image segmentation. In the template, some items are empty or null, and they will be filled together with dataset information. The part of the configuration file "hyper_parameters.yaml" is shown below. In the configuration, the items (like "bundle_root", "data_file_base_dir", and "patch_size") will be filled up automatically without any user interaction.
6969

7070
```
7171
bundle_root: null

auto3dseg/docs/hpo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The HPOGen class has a `run_algo()` function, which will be used by the third-pa
1212

1313
### Usage
1414
The tutorial on how to use NNIGen is [here](../notebooks/hpo_nni.ipynb) and the tutorial for OptunaGen is [here](../notebooks/hpo_optuna.ipynb). The list of HPO algorithms in NNI and Optuna can be found on [the NNI GitHub page](https://github.com/microsoft/nni) and [Optuna documentation](https://optuna.readthedocs.io/en/stable/reference/samplers/index.html).
15-
For demonstration purposes, both of our tutorials use a grid search HPO algorithm to optimize the learning rate in training. Users can be easily modified to random search and bayesian based methods for more hyperparameters.
15+
For demonstration purposes, both of our tutorials use a grid search HPO algorithm to optimize the learning rate in training. Users can easily switch to random search and bayesian based methods for more hyperparameters.
1616

1717
### Override Specific Parameters in the Algorithms before HPO
1818
Users can change **Auto3DSeg** algorithms in HPO by providing a set of overriding parameters.

auto3dseg/notebooks/data_analyzer.ipynb

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -105,22 +105,9 @@
105105
" {\"fold\": 1, \"image\": \"tr_image_014.fake.nii.gz\", \"label\": \"tr_label_014.fake.nii.gz\"},\n",
106106
" {\"fold\": 1, \"image\": \"tr_image_015.fake.nii.gz\", \"label\": \"tr_label_015.fake.nii.gz\"},\n",
107107
" ],\n",
108-
"}"
109-
]
110-
},
111-
{
112-
"cell_type": "markdown",
113-
"metadata": {},
114-
"source": [
115-
"## Generate image data"
116-
]
117-
},
118-
{
119-
"cell_type": "code",
120-
"execution_count": null,
121-
"metadata": {},
122-
"outputs": [],
123-
"source": [
108+
"}\n",
109+
"\n",
110+
"\n",
124111
"def simulate():\n",
125112
" test_dir = tempfile.TemporaryDirectory()\n",
126113
" dataroot = test_dir.name\n",
@@ -165,7 +152,7 @@
165152
"cell_type": "markdown",
166153
"metadata": {},
167154
"source": [
168-
"If you would like to inspect the data stats, please check the `data_stats.yaml` under the directory\n",
155+
"If you would like to inspect the data stats, please check the `data_stats.yaml` and `datastats_by_case.yaml` under the directory\n",
169156
"\n",
170157
"Next, we will perform the data analysis on a real-world dataset."
171158
]

auto3dseg/notebooks/ensemble_byoc.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
"source": [
8484
"## Simulate a special dataset\n",
8585
"\n",
86-
"It is well known that AI takes time to train. To provide the \"Hello World!\" experience of Auto3D in this notebook, we will simulate a small dataset and run training only for multiple epochs. Due to the nature of AI, the performance shouldn't be highly expected, but the entire pipeline will be completed within minutes!\n",
86+
"It is well known that AI takes time to train. To provide the \"Hello World!\" experience of Auto3DSeg in this notebook, we will simulate a small dataset and run training only for multiple epochs. Due to the nature of AI, the performance shouldn't be highly expected, but the entire pipeline will be completed within minutes!\n",
8787
"\n",
8888
"`sim_datalist` provides the information of the simulated datasets. It lists 12 training and 2 testing images and labels.\n",
8989
"The training data are split into 3 folds. Each fold will use 8 images to train and 4 images to validate.\n",

0 commit comments

Comments
 (0)