docs: correct some mistakes in Kaggle scenario guidance (#465)

* update readme correct some mistakes in guide * update the doc --------- Co-authored-by: WinstonLiye <[email protected]>
microsoft · Nov 1, 2024 · db2511a · db2511a
1 parent 21348d8
commit db2511a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -140,14 +140,24 @@ The **[🖥️ Live Demo](https://rdagent.azurewebsites.net/)** is implemented b
   ```
 
 - Run the **Automated Kaggle Model Tuning & Feature Engineering**:  self-loop model proposal and feature engineering implementation application
+  
+  **Note**: This application will automatically download Kaggle competition data unless you prepare the data locally. If you do not have the data locally, you need to configure the Kaggle API and agree to the corresponding competition rules on the Kaggle website.
   ```sh
   # 1. the competition name should must match the name used with the API on the Kaggle platform.
-  rdagent kaggle --competition [your competition name]
+  rdagent kaggle --competition [your-competition-name]
 
   # 2. Specifically, you can fill the competition name as follows:
+
+  # download the competition description files to youre local directory
   wget https://github.com/SunsetWolf/rdagent_resource/releases/download/kaggle_data/kaggle_data.zip
-  unzip kaggle_data.zip -d git_ignore_folder/kaggle_data
-  export LOCAL_DATA_PATH=path/to/git_ignore_folder/kaggle_data
+
+  # unzip the files to your local directory
+  unzip kaggle_data.zip -d /your/local/directory/kaggle_data
+
+  # set environment variables
+  export LOCAL_DATA_PATH=/your/local/directory/kaggle_data/kaggle  
+
+  # run the application
   rdagent kaggle --competition sf-crime
   ```
   The [Competition List Available](https://rdagent.readthedocs.io/en/latest/scens/kaggle_agent.html#competition-list-available) can be found here. 

diff --git a/docs/scens/kaggle_agent.rst b/docs/scens/kaggle_agent.rst
@@ -238,7 +238,7 @@ The following environment variables can be set in the `.env` file to customize t
 .. autopydantic_settings:: rdagent.components.coder.factor_coder.config.FactorImplementSettings
     :settings-show-field-summary: False
     :members: coder_use_cache, data_folder, data_folder_debug, file_based_execution_timeout, select_method, select_threshold, max_loop, knowledge_base_path, new_knowledge_base_path
-    :exclude-members: Config, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler, v2_add_fail_attempt_to_latest_successful_execution
+    :exclude-members: Config, fail_task_trial_limit, v1_query_former_trace_limit, v1_query_similar_success_limit, v2_query_component_limit, v2_query_error_limit, v2_query_former_trace_limit, v2_error_summary, v2_knowledge_sampler, v2_add_fail_attempt_to_latest_successful_execution, new_knowledge_base_path, knowledge_base_path, data_folder, data_folder_debug, select_threshold
     :no-index: