docs: Updated documentation for all the major scenarios. (#190)

* Fixed some bugs introduced during refactoring.

* update data_agent_fin_doc

* Updated documentation for the four major scenarios

* feat: remove pdfs and enable online pdf readings (#183)

* remove pdfs and enable online pdf readings

* update doc format

* use url as key

* feat: add entry for rdagent. (#187)

* Add entries

* update entry for rdagent

* lint

* fix typo

* docs: Demo links (#188)

add demo links

* fix: Fix a fail href in readme (#189)

* fix a ci bug

* doc

* feat: remove pdfs and enable online pdf readings (#183)

* remove pdfs and enable online pdf readings

* update doc format

* use url as key

* feat: add entry for rdagent. (#187)

* Add entries

* update entry for rdagent

* lint

* fix typo

* doc

* Updated documentation for med_model scenarios.

* fix a ci bug

---------

Co-authored-by: Xu Yang <peteryang@vip.qq.com>
Co-authored-by: you-n-g <you-n-g@users.noreply.github.com>
Co-authored-by: XianBW <36835909+XianBW@users.noreply.github.com>
Co-authored-by: SH-Src <suhan.c@outlook.com>

rdagent/components/coder/factor_coder/config.py

@@ -8,19 +8,23 @@ SELECT_METHOD = Literal["random", "scheduler"]
 
 class FactorImplementSettings(BaseSettings):
     class Config:
-        env_prefix = "FACTOR_CODER_"  # Use FACTOR_CODER_ as prefix for environment variables
+        env_prefix = "FACTOR_CODER_"
+        """Use `FACTOR_CODER_` as prefix for environment variables"""
 
     coder_use_cache: bool = False
-    data_folder: str = str(
-        (Path().cwd() / "git_ignore_folder" / "factor_implementation_source_data").absolute(),
-    )
-    data_folder_debug: str = str(
-        (Path().cwd() / "git_ignore_folder" / "factor_implementation_source_data_debug").absolute(),
-    )
-    cache_location: str = str(
-        (Path().cwd() / "git_ignore_folder" / "factor_implementation_execution_cache").absolute(),
-    )
-    enable_execution_cache: bool = True  # whether to enable the execution cache
+    """Indicates whether to use cache for the coder"""
+
+    data_folder: str = "git_ignore_folder/factor_implementation_source_data"
+    """Path to the folder containing financial data (default is fundamental data in Qlib)"""
+
+    data_folder_debug: str = "git_ignore_folder/factor_implementation_source_data_debug"
+    """Path to the folder containing partial financial data (for debugging)"""
+
+    cache_location: str = "git_ignore_folder/factor_implementation_execution_cache"
+    """Path to the cache location"""
+
+    enable_execution_cache: bool = True
+    """Indicates whether to enable the execution cache"""
 
     # TODO: the factor implement specific settings should not appear in this settings
     # Evolving should have a method specific settings
@@ -36,17 +40,26 @@ class FactorImplementSettings(BaseSettings):
     v2_error_summary: bool = False
     v2_knowledge_sampler: float = 1.0
 
-    file_based_execution_timeout: int = 120  # seconds for each factor implementation execution
+    file_based_execution_timeout: int = 120
+    """Timeout in seconds for each factor implementation execution"""
+
+    select_method: str = "random"
+    """Method for the selection of factors implementation"""
 
-    select_method: SELECT_METHOD = "random"
     select_threshold: int = 10
+    """Threshold for the number of factor selections"""
 
     max_loop: int = 10
+    """Maximum number of task implementation loops"""
 
     knowledge_base_path: Union[str, None] = None
+    """Path to the knowledge base"""
+
     new_knowledge_base_path: Union[str, None] = None
+    """Path to the new knowledge base"""
 
     python_bin: str = "python"
+    """Path to the Python binary"""
 
 
 FACTOR_IMPLEMENT_SETTINGS = FactorImplementSettings()