From a829b2aaea510f34bb565903ad53c175d17ea952 Mon Sep 17 00:00:00 2001 From: Linlang <30293408+SunsetWolf@users.noreply.github.com> Date: Mon, 25 Aug 2025 20:07:01 +0800 Subject: [PATCH] style: convert CLI flags from snake_case to kebab-case (#1198) Co-authored-by: Young --- README.md | 6 +++--- docs/scens/data_copilot_fin.rst | 2 +- docs/scens/data_science.rst | 6 +++--- docs/scens/model_copilot_general.rst | 2 +- docs/ui.rst | 2 +- .../example/eval/playground-series-s4e9/grade.py | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 686a6c7d..91afc8ad 100644 --- a/README.md +++ b/README.md @@ -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= + rdagent fin_factor_report --report-folder= # 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 --data_science + rdagent ui --port 19899 --log-dir --data_science ``` - 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`. diff --git a/docs/scens/data_copilot_fin.rst b/docs/scens/data_copilot_fin.rst index 379c483f..22970eab 100644 --- a/docs/scens/data_copilot_fin.rst +++ b/docs/scens/data_copilot_fin.rst @@ -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: diff --git a/docs/scens/data_science.rst b/docs/scens/data_science.rst index 3ddc63f8..0166033c 100644 --- a/docs/scens/data_science.rst +++ b/docs/scens/data_science.rst @@ -265,7 +265,7 @@ By leveraging the **Data Science** Agent, researchers and developers can acceler .. code-block:: sh - rdagent ui --port --log_dir --data_science True + rdagent ui --port --log-dir --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 --log_dir --data_science True + rdagent ui --port --log-dir --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= + rdagent grade_summary --log-folder= Here, refers to the parent directory of the log folder generated during the run. diff --git a/docs/scens/model_copilot_general.rst b/docs/scens/model_copilot_general.rst index f1286aa9..677f4a7f 100644 --- a/docs/scens/model_copilot_general.rst +++ b/docs/scens/model_copilot_general.rst @@ -96,4 +96,4 @@ You can try our demo by running the following command: .. code-block:: sh - rdagent general_model --report_file_path= + rdagent general_model --report-file-path= diff --git a/docs/ui.rst b/docs/ui.rst index 3a7492ad..eace99ee 100644 --- a/docs/ui.rst +++ b/docs/ui.rst @@ -18,7 +18,7 @@ In `RD-Agent/` folder, run: .. code-block:: bash - rdagent ui --port --log_dir [--debug] + rdagent ui --port --log-dir [--debug] This will start a web app on `http://localhost:`. diff --git a/rdagent/scenarios/data_science/example/eval/playground-series-s4e9/grade.py b/rdagent/scenarios/data_science/example/eval/playground-series-s4e9/grade.py index edcfe527..a5dfdd0c 100644 --- a/rdagent/scenarios/data_science/example/eval/playground-series-s4e9/grade.py +++ b/rdagent/scenarios/data_science/example/eval/playground-series-s4e9/grade.py @@ -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(