获取帮助

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

  1. python main.py --help

输出帮助信息结果如下：

  1. usage: main.py [-h] [-m {train,tune}] [-f CONFIG_FILE] [--db-name DB_NAME]                
  2. [--db-user DB_USER] [--port PORT] [--host HOST]                
  3. [--host-user HOST_USER] [--host-ssh-port HOST_SSH_PORT]                
  4. [--scenario {ap,tp,htap}] [--benchmark BENCHMARK]                
  5. [--model-path MODEL_PATH] [-v]  
  7. X-Tuner: a self-tuning toolkit for OpenGauss.  
  9. optional arguments:   
  10. -h, --help            show this help message and exit   
  11. -m {train,tune}, --mode {train,tune}                         
  12. train a reinforcement learning model or tune by your                         
  13. trained model.   
  14. -f CONFIG_FILE, --config-file CONFIG_FILE                         
  15. you can pass a config file path or you should manually                         
  16. set database information.   
  17. --db-name DB_NAME     database name.   
  18. --db-user DB_USER     database user name.   
  19. --port PORT           database connection port.   
  20. --host HOST           where did your database install on?   
  21. --host-user HOST_USER                         
  22. user name of the host where your database installed                         
  23. on.   
  24. --host-ssh-port HOST_SSH_PORT                         
  25. host ssh port.   
  26. --scenario {ap,tp,htap}   
  27. --benchmark BENCHMARK   
  28. --model-path MODEL_PATH                         
  29. the place where you want to save model weights to or                         
  30. load model weights from.   
  31. -v, --version         
  32. show version.