From 30bf519f6f0de32e5652e64ff46d79d3d636cddd Mon Sep 17 00:00:00 2001 From: "Jian Zhang (James)" <6593865@qq.com> Date: Wed, 4 Dec 2024 23:19:40 -0800 Subject: [PATCH] [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 Co-authored-by: xiang song(charlie.song) --- .../cli/model-training-inference/configuration-run.rst | 10 ++++++++-- docs/source/tutorials/quick-start.rst | 3 +++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/source/cli/model-training-inference/configuration-run.rst b/docs/source/cli/model-training-inference/configuration-run.rst index f363a8ac57..1961048442 100644 --- 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 index 1b6ddcb01a..50ac255ca8 100644 --- 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 \