mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-08-08 12:37:44 +00:00
style: convert CLI flags from snake_case to kebab-case (#1198)
Co-authored-by: Young <afe.young@gmail.com>
This commit is contained in:
@@ -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:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
@@ -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>`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user