monai
medical
katielink commited on
Commit
95b4f91
1 Parent(s): c5d8c54

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
@@ -56,7 +56,7 @@ The training was performed with the following:
56
 
57
  ### Memory Consumption Warning
58
 
59
- 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.
60
 
61
  ### Input
62
 
@@ -140,6 +140,12 @@ For more details usage instructions, visit the [MONAI Bundle Configuration Page]
140
  python -m monai.bundle run --config_file configs/train.json
141
  ```
142
 
 
 
 
 
 
 
143
  #### Override the `train` config to execute multi-GPU training:
144
 
145
  ```
 
56
 
57
  ### Memory Consumption Warning
58
 
59
+ 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.
60
 
61
  ### Input
62
 
 
140
  python -m monai.bundle run --config_file configs/train.json
141
  ```
142
 
143
+ 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`:
144
+
145
+ ```
146
+ python -m monai.bundle run --config_file configs/train.json --dataset_dir <actual dataset path>
147
+ ```
148
+
149
  #### Override the `train` config to execute multi-GPU training:
150
 
151
  ```
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.6",
4
  "changelog": {
 
5
  "0.1.6": "add RAM usage with CacheDataset and GPU consumtion warning",
6
  "0.1.5": "fix mgpu finalize issue",
7
  "0.1.4": "Update README Formatting",
@@ -11,7 +12,7 @@
11
  "0.1.0": "complete the model package",
12
  "0.0.1": "initialize the model package structure"
13
  },
14
- "monai_version": "1.2.0rc4",
15
  "pytorch_version": "1.13.1",
16
  "numpy_version": "1.22.2",
17
  "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.7",
4
  "changelog": {
5
+ "0.1.7": "remove error dollar symbol in readme",
6
  "0.1.6": "add RAM usage with CacheDataset and GPU consumtion warning",
7
  "0.1.5": "fix mgpu finalize issue",
8
  "0.1.4": "Update README Formatting",
 
12
  "0.1.0": "complete the model package",
13
  "0.0.1": "initialize the model package structure"
14
  },
15
+ "monai_version": "1.2.0rc6",
16
  "pytorch_version": "1.13.1",
17
  "numpy_version": "1.22.2",
18
  "optional_packages_version": {
docs/README.md CHANGED
@@ -49,7 +49,7 @@ The training was performed with the following:
49
 
50
  ### Memory Consumption Warning
51
 
52
- 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.
53
 
54
  ### Input
55
 
@@ -133,6 +133,12 @@ For more details usage instructions, visit the [MONAI Bundle Configuration Page]
133
  python -m monai.bundle run --config_file configs/train.json
134
  ```
135
 
 
 
 
 
 
 
136
  #### Override the `train` config to execute multi-GPU training:
137
 
138
  ```
 
49
 
50
  ### Memory Consumption Warning
51
 
52
+ 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.
53
 
54
  ### Input
55
 
 
133
  python -m monai.bundle run --config_file configs/train.json
134
  ```
135
 
136
+ 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`:
137
+
138
+ ```
139
+ python -m monai.bundle run --config_file configs/train.json --dataset_dir <actual dataset path>
140
+ ```
141
+
142
  #### Override the `train` config to execute multi-GPU training:
143
 
144
  ```