diff --git a/docs/scens/data_science.rst b/docs/scens/data_science.rst index 0166033c..02b749fa 100644 --- a/docs/scens/data_science.rst +++ b/docs/scens/data_science.rst @@ -62,7 +62,7 @@ By leveraging the **Data Science** Agent, researchers and developers can acceler 🔧 **Set up RD-Agent Environment** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Before you start, please make sure you have installed RD-Agent and configured the environment for RD-Agent correctly. If you want to know how to install and configure the RD-Agent, please refer to the `documentation <../installation_and_configuration.html>`_. +- Before you start, please make sure you have installed RD-Agent and configured the environment for RD-Agent correctly. If you want to know how to install and configure the RD-Agent, please refer to the `documentation <../installation_and_configuration.html>`_. - 🔩 **Setting the Environment variables at .env file** @@ -244,6 +244,16 @@ By leveraging the **Data Science** Agent, researchers and developers can acceler dotenv set DS_LOCAL_DATA_PATH /ds_data dotenv set DS_CODER_ON_WHOLE_PIPELINE True + - 📘 More Environment Variables (Optional) + + - If you want to see all the available environment variables, you can refer to the configuration file for Data Science scenarios: + + .. literalinclude:: ../../rdagent/app/data_science/conf.py + :language: python + :linenos: + + - These variables allow you to have finer-grained control in Data Science scenarios. + 🚀 **Run the Application** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -259,6 +269,12 @@ By leveraging the **Data Science** Agent, researchers and developers can acceler rdagent data_science --competition arf-12-hours-prediction-task + - More CLI Parameters for `rdagent data_science` command: + + .. automodule:: rdagent.app.data_science.loop + :members: + :no-index: + - 📈 Visualize the R&D Process - We provide a web UI to visualize the log. You just need to run: @@ -318,6 +334,16 @@ By utilizing the **Kaggle Agent**, data scientists can craft innovative solution mkdir -p /ds_data dotenv set KG_LOCAL_DATA_PATH /ds_data + - 📘 More Environment Variables (Optional) + + - If you want to see all the available environment variables, you can refer to the configuration file for Data Science scenarios: + + .. literalinclude:: ../../rdagent/app/data_science/conf.py + :language: python + :linenos: + + - These variables allow you to have finer-grained control in Data Science scenarios. + - 🗳️ **Join the competition** - If your Kaggle API account has not joined a competition, you will need to join the competition before running the program. @@ -507,6 +533,12 @@ By utilizing the **Kaggle Agent**, data scientists can craft innovative solution rdagent data_science --competition playground-series-s4e9 + - More CLI Parameters for `rdagent data_science` command: + + .. automodule:: rdagent.app.data_science.loop + :members: + :no-index: + - 📈 Visualize the R&D Process - We provide a web UI to visualize the log. You just need to run: diff --git a/rdagent/app/data_science/loop.py b/rdagent/app/data_science/loop.py index 560e71e3..5d68429c 100644 --- a/rdagent/app/data_science/loop.py +++ b/rdagent/app/data_science/loop.py @@ -41,6 +41,9 @@ def main( Number of loops to run; if None, the process will run indefinitely until an error or KeyboardInterrupt occurs. - If the current loop is incomplete, it will be counted as the first loop for completion. - If both step_n and loop_n are provided, the process will stop as soon as either condition is met. + timeout : + Maximum duration to run the loop. Accepts a string format recognized by the internal timer. + - If None, the loop will run until completion, error, or KeyboardInterrupt. competition : Competition name. replace_timer : @@ -51,9 +54,11 @@ def main( Auto R&D Evolving loop for models in a Kaggle scenario. You can continue running a session by using the command: + .. code-block:: bash - dotenv run -- python rdagent/app/data_science/loop.py [--competition titanic] $LOG_PATH/__session__/1/0_propose --step_n 1 # `step_n` is an optional parameter - rdagent kaggle --competition playground-series-s4e8 # This command is recommended. + + dotenv run -- python rdagent/app/data_science/loop.py [--competition titanic] $LOG_PATH/__session__/1/0_propose --step_n 1 # `step_n` is an optional parameter + rdagent kaggle --competition playground-series-s4e8 # This command is recommended. """ if not checkout_path is None: checkout = Path(checkout_path)