[Fix] Fix issue #1052 (#1105)

*Issue #, if available:* #1052 *Description of changes:* This PR adds additional information for users to use the `workspace` configuration. Also change the format of HINT to Note. Preview of configuration: https://james4graphstorm.readthedocs.io/en/james_1052/cli/model-training-inference/configuration-run.html Preview of quick-start: https://james4graphstorm.readthedocs.io/en/james_1052/tutorials/quick-start.html By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. --------- Co-authored-by: Ubuntu <[email protected]> Co-authored-by: xiang song(charlie.song) <[email protected]>
awslabs · Dec 5, 2024 · 30bf519 · 30bf519
1 parent 933f6e4
commit 30bf519
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/docs/source/cli/model-training-inference/configuration-run.rst b/docs/source/cli/model-training-inference/configuration-run.rst
@@ -8,8 +8,14 @@ Launch CLI Arguments
 GraphStorm's model training and inference launch CLIs (both task-specific and task-agnostic) have a set of parameters to configure system enviornment for training and inference.
 
 - **workspace**: the folder where launch command assume all artifacts were saved. If the other parameters' file paths are relative paths, launch command will consider these files in the workspace.
-- **part-config**: (**Required**) Path to a file containing graph partition configuration. The graph partition is generated by GraphStorm Partition tools. **HINT**: Use absolute path to avoid any path related problems. Otherwise, the file should be in workspace.
-- **ip-config**: Path to a file containing IP addresses of instances in a distributed cluster. In the ip config file, each line stores one IP. This configuration is required only for model training and inference on distributed clusters. **HINT**: Use absolute path to avoid any path related problems. Otherwise, the file should be in workspace.
+
+    .. Note:: Users need to create the workspace folder beforehand to avoid errors.
+- **part-config**: (**Required**) Path to a file containing graph partition configuration. The graph partition is generated by GraphStorm Partition tools.
+
+    .. Note:: Use absolute path to avoid any path related problems. Otherwise, the file should be in ``workspace``.
+- **ip-config**: Path to a file containing IP addresses of instances in a distributed cluster. In the ip config file, each line stores one IP. This configuration is required only for model training and inference on distributed clusters.
+
+    .. Note:: Use absolute path to avoid any path related problems. Otherwise, the file should be in ``workspace``.
 - **num-trainers**: The number of trainer processes per machine. Should >0.
 - **num-servers**: The number of server processes per machine. Should >0.
 - **num-samplers**: The number of sampler processes per trainer process. Should >=0.

diff --git a/docs/source/tutorials/quick-start.rst b/docs/source/tutorials/quick-start.rst
@@ -58,6 +58,9 @@ Run the below command to start a training job that trains a built-in RGCN model
 
 .. code-block:: bash
 
+    # create the workspace folder first, if it does not exist yet
+    mkdir /tmp/ogbn-arxiv-nc
+
     python -m graphstorm.run.gs_node_classification \
               --workspace /tmp/ogbn-arxiv-nc \
               --num-trainers 1 \