NexQuant/rdagent/scenarios/qlib/experiment/model_experiment.py

from copy import deepcopy
from pathlib import Path

from rdagent.app.qlib_rd_loop.conf import MODEL_PROP_SETTING
from rdagent.components.coder.model_coder.conf import get_model_env
from rdagent.components.coder.model_coder.model import (
    ModelExperiment,
    ModelFBWorkspace,
    ModelTask,
)
from rdagent.core.experiment import Task
from rdagent.core.scenario import Scenario
from rdagent.scenarios.qlib.experiment.workspace import QlibFBWorkspace
from rdagent.scenarios.shared.get_runtime_info import get_runtime_environment_by_env
from rdagent.utils.agent.tpl import T


class QlibModelExperiment(ModelExperiment[ModelTask, QlibFBWorkspace, ModelFBWorkspace]):
    def __init__(self, *args, **kwargs) -> None:
        super().__init__(*args, **kwargs)
        self.experiment_workspace = QlibFBWorkspace(template_folder_path=Path(__file__).parent / "model_template")
        self.stdout = ""
        self.base_features: dict[str, str] = {}


class QlibModelScenario(Scenario):
    def __init__(self) -> None:
        super().__init__()
        self._background = deepcopy(
            T(".prompts:qlib_model_background").r(
                runtime_environment=self.get_runtime_environment(),
            )
        )
        self._output_format = deepcopy(T(".prompts:qlib_model_output_format").r())
        self._interface = deepcopy(T(".prompts:qlib_model_interface").r())
        self._simulator = deepcopy(T(".prompts:qlib_model_simulator").r())
        self._rich_style_description = deepcopy(T(".prompts:qlib_model_rich_style_description").r())
        self._experiment_setting = deepcopy(
            T(".prompts:qlib_model_experiment_setting").r(
                train_start=MODEL_PROP_SETTING.train_start,
                train_end=MODEL_PROP_SETTING.train_end,
                valid_start=MODEL_PROP_SETTING.valid_start,
                valid_end=MODEL_PROP_SETTING.valid_end,
                test_start=MODEL_PROP_SETTING.test_start,
                test_end=MODEL_PROP_SETTING.test_end,
            )
        )

    @property
    def background(self) -> str:
        return self._background

    @property
    def source_data(self) -> str:
        raise NotImplementedError("source_data of QlibModelScenario is not implemented")

    @property
    def output_format(self) -> str:
        return self._output_format

    @property
    def interface(self) -> str:
        return self._interface

    @property
    def simulator(self) -> str:
        return self._simulator

    @property
    def rich_style_description(self) -> str:
        return self._rich_style_description

    @property
    def experiment_setting(self) -> str:
        return self._experiment_setting

    def get_scenario_all_desc(
        self, task: Task | None = None, filtered_tag: str | None = None, simple_background: bool | None = None
    ) -> str:
        return f"""Background of the scenario:
{self.background}
The interface you should follow to write the runnable code:
{self.interface}
The output of your code should be in the format:
{self.output_format}
The simulator user can use to test your model:
{self.simulator}
"""

    def get_runtime_environment(self):
        model_env = get_model_env()
        stdout = get_runtime_environment_by_env(env=model_env)
        return stdout