monai
medical
katielink commited on
Commit
c3db148
1 Parent(s): 4528beb

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
@@ -36,7 +36,7 @@ The training was performed with the following:
36
 
37
  ### Memory Consumption Warning
38
 
39
- 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.
40
 
41
  ### Input
42
  One channel
@@ -94,6 +94,12 @@ For more details usage instructions, visit the [MONAI Bundle Configuration Page]
94
  python -m monai.bundle run --config_file configs/train.json
95
  ```
96
 
 
 
 
 
 
 
97
  #### Override the `train` config to execute multi-GPU training:
98
 
99
  ```
 
36
 
37
  ### Memory Consumption Warning
38
 
39
+ 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.
40
 
41
  ### Input
42
  One channel
 
94
  python -m monai.bundle run --config_file configs/train.json
95
  ```
96
 
97
+ 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`:
98
+
99
+ ```
100
+ python -m monai.bundle run --config_file configs/train.json --dataset_dir <actual dataset path>
101
+ ```
102
+
103
  #### Override the `train` config to execute multi-GPU training:
104
 
105
  ```
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.5.1",
4
  "changelog": {
 
5
  "0.5.1": "add RAM warning",
6
  "0.5.0": "update the README file with the ONNX-TensorRT conversion",
7
  "0.4.9": "update TensorRT descriptions",
@@ -29,7 +30,7 @@
29
  "0.1.0": "complete the model package",
30
  "0.0.1": "initialize the model package structure"
31
  },
32
- "monai_version": "1.2.0rc5",
33
  "pytorch_version": "1.13.1",
34
  "numpy_version": "1.22.2",
35
  "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.5.2",
4
  "changelog": {
5
+ "0.5.2": "remove error dollar symbol in readme",
6
  "0.5.1": "add RAM warning",
7
  "0.5.0": "update the README file with the ONNX-TensorRT conversion",
8
  "0.4.9": "update TensorRT descriptions",
 
30
  "0.1.0": "complete the model package",
31
  "0.0.1": "initialize the model package structure"
32
  },
33
+ "monai_version": "1.2.0rc6",
34
  "pytorch_version": "1.13.1",
35
  "numpy_version": "1.22.2",
36
  "optional_packages_version": {
docs/README.md CHANGED
@@ -29,7 +29,7 @@ The training was performed with the following:
29
 
30
  ### Memory Consumption Warning
31
 
32
- 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.
33
 
34
  ### Input
35
  One channel
@@ -87,6 +87,12 @@ For more details usage instructions, visit the [MONAI Bundle Configuration Page]
87
  python -m monai.bundle run --config_file configs/train.json
88
  ```
89
 
 
 
 
 
 
 
90
  #### Override the `train` config to execute multi-GPU training:
91
 
92
  ```
 
29
 
30
  ### Memory Consumption Warning
31
 
32
+ 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.
33
 
34
  ### Input
35
  One channel
 
87
  python -m monai.bundle run --config_file configs/train.json
88
  ```
89
 
90
+ 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`:
91
+
92
+ ```
93
+ python -m monai.bundle run --config_file configs/train.json --dataset_dir <actual dataset path>
94
+ ```
95
+
96
  #### Override the `train` config to execute multi-GPU training:
97
 
98
  ```