gavindiaz/NexQuant
1
0
Fork 0
mirror of https://github.com/NicolasBohn/NexQuant.git synced 2026-08-08 20:47:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add documentation for Data Science configurable options (#1301)

Browse Source
This commit is contained in:
Linlang
2025-11-25 16:56:30 +08:00
committed by GitHub
parent c067ea6400
commit d603d5a5aa
2 changed files with 40 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/scens/data_science.rst
+33 -1
View File
@@ -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 <your local directory>/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 <your local directory>/ds_data
dotenv set KG_LOCAL_DATA_PATH <your local directory>/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: