monai
medical
katielink commited on
Commit
fd8c5bc
1 Parent(s): 5c16b7b

remove error dollar symbol in readme

Browse files
Files changed (3) hide show
  1. README.md +7 -1
  2. configs/metadata.json +3 -2
  3. docs/README.md +7 -1
README.md CHANGED
@@ -98,7 +98,7 @@ The training was performed with the following:
98
 
99
  ### Memory Consumption Warning
100
 
101
- If you face memory issues with CacheDataset, you can either switch to a regular Dataset class or lower the caching rate `cache_rate` in the configurations within range $(0, 1)$ to minimize the System RAM requirements.
102
 
103
  ## Input
104
  5 channels
@@ -143,6 +143,12 @@ For more details usage instructions, visit the [MONAI Bundle Configuration Page]
143
  python -m monai.bundle run --config_file configs/train.json
144
  ```
145
 
 
 
 
 
 
 
146
  #### Override the `train` config to execute multi-GPU training:
147
 
148
  ```
 
98
 
99
  ### Memory Consumption Warning
100
 
101
+ If you face memory issues with CacheDataset, you can either switch to a regular Dataset class or lower the caching rate `cache_rate` in the configurations within range [0, 1] to minimize the System RAM requirements.
102
 
103
  ## Input
104
  5 channels
 
143
  python -m monai.bundle run --config_file configs/train.json
144
  ```
145
 
146
+ Please note that if the default dataset path is not modified with the actual path in the bundle config files, you can also override it by using `--dataset_dir`:
147
+
148
+ ```
149
+ python -m monai.bundle run --config_file configs/train.json --dataset_dir <actual dataset path>
150
+ ```
151
+
152
  #### Override the `train` config to execute multi-GPU training:
153
 
154
  ```
configs/metadata.json CHANGED
@@ -1,7 +1,8 @@
1
  {
2
  "schema": "https://github.com/Project-MONAI/MONAI-extra-test-data/releases/download/0.8.1/meta_schema_20220324.json",
3
- "version": "0.1.2",
4
  "changelog": {
 
5
  "0.1.2": "add RAM usage with CachDataset",
6
  "0.1.1": "deterministic retrain benchmark and add link",
7
  "0.1.0": "fix mgpu finalize issue",
@@ -15,7 +16,7 @@
15
  "0.0.2": "Update The Torch Vision Transform",
16
  "0.0.1": "initialize the model package structure"
17
  },
18
- "monai_version": "1.2.0rc4",
19
  "pytorch_version": "1.13.1",
20
  "numpy_version": "1.22.2",
21
  "optional_packages_version": {
 
1
  {
2
  "schema": "https://github.com/Project-MONAI/MONAI-extra-test-data/releases/download/0.8.1/meta_schema_20220324.json",
3
+ "version": "0.1.3",
4
  "changelog": {
5
+ "0.1.3": "remove error dollar symbol in readme",
6
  "0.1.2": "add RAM usage with CachDataset",
7
  "0.1.1": "deterministic retrain benchmark and add link",
8
  "0.1.0": "fix mgpu finalize issue",
 
16
  "0.0.2": "Update The Torch Vision Transform",
17
  "0.0.1": "initialize the model package structure"
18
  },
19
+ "monai_version": "1.2.0rc6",
20
  "pytorch_version": "1.13.1",
21
  "numpy_version": "1.22.2",
22
  "optional_packages_version": {
docs/README.md CHANGED
@@ -91,7 +91,7 @@ The training was performed with the following:
91
 
92
  ### Memory Consumption Warning
93
 
94
- If you face memory issues with CacheDataset, you can either switch to a regular Dataset class or lower the caching rate `cache_rate` in the configurations within range $(0, 1)$ to minimize the System RAM requirements.
95
 
96
  ## Input
97
  5 channels
@@ -136,6 +136,12 @@ For more details usage instructions, visit the [MONAI Bundle Configuration Page]
136
  python -m monai.bundle run --config_file configs/train.json
137
  ```
138
 
 
 
 
 
 
 
139
  #### Override the `train` config to execute multi-GPU training:
140
 
141
  ```
 
91
 
92
  ### Memory Consumption Warning
93
 
94
+ If you face memory issues with CacheDataset, you can either switch to a regular Dataset class or lower the caching rate `cache_rate` in the configurations within range [0, 1] to minimize the System RAM requirements.
95
 
96
  ## Input
97
  5 channels
 
136
  python -m monai.bundle run --config_file configs/train.json
137
  ```
138
 
139
+ Please note that if the default dataset path is not modified with the actual path in the bundle config files, you can also override it by using `--dataset_dir`:
140
+
141
+ ```
142
+ python -m monai.bundle run --config_file configs/train.json --dataset_dir <actual dataset path>
143
+ ```
144
+
145
  #### Override the `train` config to execute multi-GPU training:
146
 
147
  ```