style: convert CLI flags from snake_case to kebab-case (#1198)

Co-authored-by: Young <afe.young@gmail.com>
This commit is contained in:
Linlang
2025-08-25 20:07:01 +08:00
committed by GitHub
parent e4bd647d1b
commit a829b2aaea
6 changed files with 10 additions and 10 deletions
+3 -3
View File
@@ -270,12 +270,12 @@ The **[🖥️ Live Demo](https://rdagent.azurewebsites.net/)** is implemented b
- Run the **Automated Quantitative Trading & Factors Extraction from Financial Reports**: Run the [Qlib](http://github.com/microsoft/qlib) factor extraction and implementation application based on financial reports
```sh
# 1. Generally, you can run this scenario using the following command:
rdagent fin_factor_report --report_folder=<Your financial reports folder path>
rdagent fin_factor_report --report-folder=<Your financial reports folder path>
# 2. Specifically, you need to prepare some financial reports first. You can follow this concrete example:
wget https://github.com/SunsetWolf/rdagent_resource/releases/download/reports/all_reports.zip
unzip all_reports.zip -d git_ignore_folder/reports
rdagent fin_factor_report --report_folder=git_ignore_folder/reports
rdagent fin_factor_report --report-folder=git_ignore_folder/reports
```
- Run the **Automated Model Research & Development Copilot**: model extraction and implementation application
@@ -340,7 +340,7 @@ The **[🖥️ Live Demo](https://rdagent.azurewebsites.net/)** is implemented b
- You can run the following command for our demo program to see the run logs.
```sh
rdagent ui --port 19899 --log_dir <your log folder like "log/"> --data_science <True or False>
rdagent ui --port 19899 --log-dir <your log folder like "log/"> --data_science <True or False>
```
- About the `data_science` parameter: If you want to see the logs of the data science scenario, set the `data_science` parameter to `True`; otherwise set it to `False`.
+1 -1
View File
@@ -125,7 +125,7 @@ You can try our demo by running the following command:
.. code-block:: sh
rdagent fin_factor_report --report_folder=git_ignore_folder/reports
rdagent fin_factor_report --report-folder=git_ignore_folder/reports
- Alternatively, you can store the paths of the reports in `report_result_json_file_path`. The format should be:
+3 -3
View File
@@ -265,7 +265,7 @@ By leveraging the **Data Science** Agent, researchers and developers can acceler
.. code-block:: sh
rdagent ui --port <custom port> --log_dir <your log folder like "log/"> --data_science True
rdagent ui --port <custom port> --log-dir <your log folder like "log/"> --data_science True
- Then you can input the log path and visualize the R&D process.
@@ -513,7 +513,7 @@ By utilizing the **Kaggle Agent**, data scientists can craft innovative solution
.. code-block:: sh
rdagent ui --port <custom port> --log_dir <your log folder like "log/"> --data_science True
rdagent ui --port <custom port> --log-dir <your log folder like "log/"> --data_science True
- Then you can input the log path and visualize the R&D process.
@@ -529,6 +529,6 @@ By utilizing the **Kaggle Agent**, data scientists can craft innovative solution
.. code-block:: sh
rdagent grade_summary --log_folder=<url_to_log>
rdagent grade_summary --log-folder=<url_to_log>
Here, <url_to_log> refers to the parent directory of the log folder generated during the run.
+1 -1
View File
@@ -96,4 +96,4 @@ You can try our demo by running the following command:
.. code-block:: sh
rdagent general_model --report_file_path=<path_to_pdf_file>
rdagent general_model --report-file-path=<path_to_pdf_file>
+1 -1
View File
@@ -18,7 +18,7 @@ In `RD-Agent/` folder, run:
.. code-block:: bash
rdagent ui --port <port> --log_dir <log_dir like "log/"> [--debug]
rdagent ui --port <port> --log-dir <log_dir like "log/"> [--debug]
This will start a web app on `http://localhost:<port>`.
@@ -61,7 +61,7 @@ if __name__ == "__main__":
}
# The output must be in json format. To configure the full output,
# you can run the command `rdagent grade_summary --log_folder` to summarize the scores at the end of the program.
# you can run the command `rdagent grade_summary --log-folder` to summarize the scores at the end of the program.
# If you don't need it, you can just provide the `competition_id`` and `score``.
print(
json.dumps(