feat(cli): join command set default value as 'auto' (#39)

Co-authored-by: sibianl <sibianl@rings.net.cn>

Author: sl-gn

README.md

@@ -111,6 +111,9 @@ Select model config and click continue.
 ![Node join](docs/images/node-join.png)
 This page will show the join command like blow.
 ```sh
+# local area network env
+parallax join
+# public network env
 parallax join -s {scheduler-address}
 # example
 parallax join -s /ip4/192.168.1.2/tcp/5001/p2p/xxxxxxxxxxxx
@@ -136,6 +139,9 @@ Please notice and record the scheduler ip4 address generated in the terminal.
 #### Step 2: Join each distributed nodes
 For each distributed nodes including the main node, open a terminal and join the server with the scheduler address.
 ```sh
+# local area network env
+parallax join
+# public network env
 parallax join -s {scheduler-address}
 ```
 For example:

scripts/README.md

@@ -8,12 +8,14 @@ fi
 helpFunction()
 {
    echo ""
-   echo "Usage: $0 -s SCHEDULER_ADDR"
-   echo -e "\t-s Description of what is SCHEDULER_ADDR"
+   echo "Usage: $0 [-s SCHEDULER_ADDR]"
+   echo -e "\t-s SCHEDULER_ADDR (default: auto)"
    exit 1 # Exit script after printing help
 }
 
-while getopts "s:m:i:" opt
+SCHEDULER_ADDR="auto"
+
+while getopts "s:" opt
 do
    case "$opt" in
       s ) SCHEDULER_ADDR="$OPTARG" ;;
@@ -24,11 +26,9 @@ done
 # Print helpFunction in case parameters are empty
 if [ -z "$SCHEDULER_ADDR" ]
 then
-   echo "Some or all of the parameters are empty";
-   helpFunction
+   SCHEDULER_ADDR="auto"
 fi
 
-# Begin script in case all parameters are correct
 echo "$SCHEDULER_ADDR"
 
 export SGL_ENABLE_JIT_DEEPGEMM=0

scripts/join.sh

@@ -29,7 +29,7 @@
     "nvidia/Llama-3.1-8B-Instruct-FP8",
 ]
 
-NODE_JOIN_COMMAND_LOCAL_NETWORK = """parallax join -s {scheduler_addr}"""
+NODE_JOIN_COMMAND_LOCAL_NETWORK = """parallax join"""
 
 NODE_JOIN_COMMAND_PUBLIC_NETWORK = """parallax join -s {scheduler_addr}"""
 

src/backend/server/static_config.py

@@ -151,7 +151,7 @@ def main():
         "join", help="Join a distributed cluster (equivalent to scripts/join.sh)"
     )
     join_parser.add_argument(
-        "-s", "--scheduler-addr", type=str, help="Scheduler address (required)"
+        "-s", "--scheduler-addr", default="auto", type=str, help="Scheduler address (required)"
     )
 
     args = parser.parse_args()