Merge pull request #1461 from FedML-AI/alexleung/dev_branch

[Docs] update the README.md for train and federate build.
FedML-AI · Oct 19, 2023 · 022f70f · 022f70f
2 parents 5b63d73 + 9148de2
commit 022f70f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/python/examples/launch/federate_build_package/README.md b/python/examples/launch/federate_build_package/README.md
@@ -55,16 +55,20 @@ fedml_model_args:
 ```
 
 The above model and data arguments will be mapped to the equivalent environment variables as follows.
+```
 dataset_name = $FEDML_DATASET_NAME
 dataset_path = $FEDML_DATASET_PATH
 dataset_type = $FEDML_DATASET_TYPE
 model_name = $FEDML_MODEL_NAME
 model_cache_path = $FEDML_MODEL_CACHE_PATH
 input_dim = $FEDML_MODEL_INPUT_DIM
 output_dim = $FEDML_MODEL_OUTPUT_DIM
+```
 
-Your may pass these environment variables as your entry arguments.
-e.g., ENTRY_ARGS_MODEL_DATA='-m $FEDML_MODEL_NAME -mc $FEDML_MODEL_CACHE_PATH -mi $FEDML_MODEL_INPUT_DIM -mo $FEDML_MODEL_OUTPUT_DIM -dn $FEDML_DATASET_NAME -dt $FEDML_DATASET_TYPE -dp $FEDML_DATASET_PATH'
+Your may pass these environment variables as your entry arguments. e.g.,
+```
+ENTRY_ARGS_MODEL_DATA='-m $FEDML_MODEL_NAME -mc $FEDML_MODEL_CACHE_PATH -mi $FEDML_MODEL_INPUT_DIM -mo $FEDML_MODEL_OUTPUT_DIM -dn $FEDML_DATASET_NAME -dt $FEDML_DATASET_TYPE -dp $FEDML_DATASET_PATH'
+```
 
 ### Examples
 ```

diff --git a/python/examples/launch/train_build_package/README.md b/python/examples/launch/train_build_package/README.md
@@ -53,16 +53,20 @@ fedml_model_args:
 ```
 
 The above model and data arguments will be mapped to the equivalent environment variables as follows.
+```
 dataset_name = $FEDML_DATASET_NAME
 dataset_path = $FEDML_DATASET_PATH
 dataset_type = $FEDML_DATASET_TYPE
 model_name = $FEDML_MODEL_NAME
 model_cache_path = $FEDML_MODEL_CACHE_PATH
 input_dim = $FEDML_MODEL_INPUT_DIM
 output_dim = $FEDML_MODEL_OUTPUT_DIM
+```
 
-Your may pass these environment variables as your entry arguments.
-e.g., ENTRY_ARGS_MODEL_DATA='-m $FEDML_MODEL_NAME -mc $FEDML_MODEL_CACHE_PATH -mi $FEDML_MODEL_INPUT_DIM -mo $FEDML_MODEL_OUTPUT_DIM -dn $FEDML_DATASET_NAME -dt $FEDML_DATASET_TYPE -dp $FEDML_DATASET_PATH'
+Your may pass these environment variables as your entry arguments. e.g.,
+```
+ENTRY_ARGS_MODEL_DATA='-m $FEDML_MODEL_NAME -mc $FEDML_MODEL_CACHE_PATH -mi $FEDML_MODEL_INPUT_DIM -mo $FEDML_MODEL_OUTPUT_DIM -dn $FEDML_DATASET_NAME -dt $FEDML_DATASET_TYPE -dp $FEDML_DATASET_PATH'
+```
 
 ### Examples
 ```