docs: refine the README (#244)

* init a scenario for kaggle feature engineering

* update the readme

* Delete rdagent/app/kaggle_feature/conf.py

* update some pictures

* Delete rdagent/app/kaggle_feature/model.py

* change a photo

* add pics to docs

* update the readme

* update the README

* for a try

* for another try

* change the style of the pictures in readme

* fix a small bug

* update the readme and the docs

* update the docs

* fix a typo

* change a website url

* change some styles

* fix a typo

* change the size of the logo

* change two urls

* Update README.md

* Update README.md

* Update README.md

* Update README.md

---------

Co-authored-by: Linlang <Lv.Linlang@hotmail.com>
This commit is contained in:
WinstonLiyt
2024-09-06 15:39:41 +08:00
committed by GitHub
parent fd8f371577
commit 0dc9247153
17 changed files with 217 additions and 156 deletions
+13 -12
View File
@@ -110,7 +110,7 @@ class FactorReportLoop(FactorRDLoop, metaclass=LoopMeta):
open(FACTOR_FROM_REPORT_PROP_SETTING.report_result_json_file_path, "r")
)
else:
self.judge_pdf_data_items = Path(report_folder).rglob("*.pdf")
self.judge_pdf_data_items = [i for i in Path(report_folder).rglob("*.pdf")]
self.pdf_file_index = 0
self.valid_pdf_file_count = 0
@@ -146,21 +146,22 @@ class FactorReportLoop(FactorRDLoop, metaclass=LoopMeta):
return self.current_loop_exp
def main(path=None, step_n=None):
def main(report_folder=None, path=None, step_n=None):
"""
Auto R&D Evolving loop for fintech factors (the factors are extracted from finance report).
You can continue running session by
.. code-block:: python
dotenv run -- python rdagent/app/qlib_rd_loop/factor_from_report.py $LOG_PATH/__session__/1/0_propose --step_n 1 # `step_n` is a optional parameter
Auto R&D Evolving loop for fintech factors (the factors are extracted from finance reports).
Args:
report_folder (str, optional): The folder contains the report PDF files. Reports will be loaded from this folder.
path (str, optional): The path for loading a session. If provided, the session will be loaded.
step_n (int, optional): Step number to continue running a session.
"""
if path is None:
model_loop = FactorReportLoop(FACTOR_FROM_REPORT_PROP_SETTING)
else:
if path is None and report_folder is None:
model_loop = FactorReportLoop()
elif path is not None:
model_loop = FactorReportLoop.load(path)
else:
model_loop = FactorReportLoop(report_folder=report_folder)
model_loop.run(step_n=step_n)
+1 -1
View File
@@ -586,7 +586,7 @@ class TraceWindow(StWindow):
self.show_llm = show_llm
self.show_common_logs = show_common_logs
image_c, scen_c = container.columns([2, 3], vertical_alignment="center")
image_c.image("scen.jpg")
image_c.image("scen.png")
scen_c.container(border=True).markdown(QlibModelScenario().rich_style_description)
top_container = container.container()
col1, col2 = top_container.columns([2, 3])