enhance readme on commands example

README.md

@@ -42,6 +42,9 @@ Override the `train` config to execute multi-GPU training:
 torchrun --standalone --nnodes=1 --nproc_per_node=2 -m monai.bundle run training --meta_file configs/metadata.json --config_file "['configs/train.json','configs/multi_gpu_train.json']" --logging_file configs/logging.conf
 ```
 
+Please note that the distributed training related options depend on the actual running environment, thus you may need to remove `--standalone`, modify `--nnodes` or do some other necessary changes according to the machine you used.
+Please refer to [pytorch's official tutorial](https://pytorch.org/tutorials/intermediate/ddp_tutorial.html) for more details.
+
 Override the `train` config to execute evaluation with the trained model:
 
 ```

configs/metadata.json

@@ -1,7 +1,8 @@
 {
     "schema": "https://github.com/Project-MONAI/MONAI-extra-test-data/releases/download/0.8.1/meta_schema_20220324.json",
-    "version": "0.3.3",
+    "version": "0.3.4",
     "changelog": {
+        "0.3.4": "enhance readme on commands example",
         "0.3.3": "fix license Copyright error",
         "0.3.2": "improve multi-gpu logging",
         "0.3.1": "add multi-gpu evaluation config",

docs/README.md

@@ -35,6 +35,9 @@ Override the `train` config to execute multi-GPU training:
 torchrun --standalone --nnodes=1 --nproc_per_node=2 -m monai.bundle run training --meta_file configs/metadata.json --config_file "['configs/train.json','configs/multi_gpu_train.json']" --logging_file configs/logging.conf
 ```
 
+Please note that the distributed training related options depend on the actual running environment, thus you may need to remove `--standalone`, modify `--nnodes` or do some other necessary changes according to the machine you used.
+Please refer to [pytorch's official tutorial](https://pytorch.org/tutorials/intermediate/ddp_tutorial.html) for more details.
+
 Override the `train` config to execute evaluation with the trained model:
 
 ```