获取帮助

启动调优程序之前，可以通过如下命令获取帮助信息：

python main.py --help

输出帮助信息结果如下：

usage: main.py [-h] [-m {train,tune}] [-f CONFIG_FILE] [--db-name DB_NAME]
               [--db-user DB_USER] [--db-user-pwd DB_USER_PWD] [--port PORT]
               [--host HOST] [--host-user HOST_USER]
               [--host-user-pwd HOST_USER_PWD] [--host-ssh-port HOST_SSH_PORT]
               [--scenario {ap,tp,htap}] [--benchmark BENCHMARK]
               [--model-path MODEL_PATH] [-v]

X-Tuner: a self-tuning toolkit for OpenGauss.

optional arguments:
  -h, --help            show this help message and exit
  -m {train,tune}, --mode {train,tune}
                        train a reinforcement learning model or tune by your
                        trained model.
  -f CONFIG_FILE, --config-file CONFIG_FILE
                        you can pass a config file path or you should manually
                        set database information.
  --db-name DB_NAME     database name.
  --db-user DB_USER     database user name.
  --db-user-pwd DB_USER_PWD
                        database user password.
  --port PORT           database connection port.
  --host HOST           where did your database install on?
  --host-user HOST_USER
                        user name of the host where your database installed
                        on.
  --host-user-pwd HOST_USER_PWD
                        user password of the host where your database
                        installed on.
  --host-ssh-port HOST_SSH_PORT
                        host ssh port.
  --scenario {ap,tp,htap}
  --benchmark BENCHMARK
  --model-path MODEL_PATH
                        the place where you want to save model weights to or
                        load model weights from.
  -v, --version         show version.