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/app/qlib_rd_loop/conf.py

@@ -1,45 +1,79 @@
+from pydantic_settings import BaseSettings
+
 from rdagent.components.workflow.conf import BasePropSetting
 
 
 class ModelBasePropSetting(BasePropSetting):
     class Config:
-        env_prefix = "QLIB_MODEL_"  # Use MODEL_CODER_ as prefix for environment variables
-        protected_namespaces = ()  # Add 'model_' to the protected namespaces
+        env_prefix = "QLIB_MODEL_"
+        """Use `QLIB_MODEL_` as prefix for environment variables"""
+        protected_namespaces = ()
+        """Add 'model_' to the protected namespaces"""
 
+    # 1) override base settings
     scen: str = "rdagent.scenarios.qlib.experiment.model_experiment.QlibModelScenario"
+    """Scenario class for Qlib Model"""
+
     hypothesis_gen: str = "rdagent.scenarios.qlib.proposal.model_proposal.QlibModelHypothesisGen"
+    """Hypothesis generation class"""
+
     hypothesis2experiment: str = "rdagent.scenarios.qlib.proposal.model_proposal.QlibModelHypothesis2Experiment"
+    """Hypothesis to experiment class"""
+
     coder: str = "rdagent.scenarios.qlib.developer.model_coder.QlibModelCoSTEER"
+    """Coder class"""
+
     runner: str = "rdagent.scenarios.qlib.developer.model_runner.QlibModelRunner"
+    """Runner class"""
+
     summarizer: str = "rdagent.scenarios.qlib.developer.feedback.QlibModelHypothesisExperiment2Feedback"
+    """Summarizer class"""
 
     evolving_n: int = 10
+    """Number of evolutions"""
 
 
 class FactorBasePropSetting(BasePropSetting):
     class Config:
-        env_prefix = "QLIB_FACTOR_"  # Use MODEL_CODER_ as prefix for environment variables
-        protected_namespaces = ()  # Add 'model_' to the protected namespaces
+        env_prefix = "QLIB_FACTOR_"
+        """Use `QLIB_FACTOR_` as prefix for environment variables"""
+        protected_namespaces = ()
+        """Add 'factor_' to the protected namespaces"""
 
     # 1) override base settings
-    # TODO: model part is not finished yet
     scen: str = "rdagent.scenarios.qlib.experiment.factor_experiment.QlibFactorScenario"
+    """Scenario class for Qlib Factor"""
+
     hypothesis_gen: str = "rdagent.scenarios.qlib.proposal.factor_proposal.QlibFactorHypothesisGen"
+    """Hypothesis generation class"""
+
     hypothesis2experiment: str = "rdagent.scenarios.qlib.proposal.factor_proposal.QlibFactorHypothesis2Experiment"
+    """Hypothesis to experiment class"""
+
     coder: str = "rdagent.scenarios.qlib.developer.factor_coder.QlibFactorCoSTEER"
+    """Coder class"""
+
     runner: str = "rdagent.scenarios.qlib.developer.factor_runner.QlibFactorRunner"
+    """Runner class"""
+
     summarizer: str = "rdagent.scenarios.qlib.developer.feedback.QlibFactorHypothesisExperiment2Feedback"
+    """Summarizer class"""
 
     evolving_n: int = 10
-
-    # 2) sub task specific:
-    report_result_json_file_path: str = "git_ignore_folder/report_list.json"
-    max_factors_per_exp: int = 10000
+    """Number of evolutions"""
 
 
 class FactorFromReportPropSetting(FactorBasePropSetting):
-    # Override the scen attribute
+    # 1) override the scen attribute
     scen: str = "rdagent.scenarios.qlib.experiment.factor_from_report_experiment.QlibFactorFromReportScenario"
+    """Scenario class for Qlib Factor from Report"""
+
+    # 2) sub task specific:
+    report_result_json_file_path: str = "git_ignore_folder/report_list.json"
+    """Path to the JSON file listing research reports for factor extraction"""
+
+    max_factors_per_exp: int = 10000
+    """Maximum number of factors implemented per experiment"""
 
 
 FACTOR_PROP_SETTING = FactorBasePropSetting()