update docs (#139)

* update docs

* Update README.md

* Update project_framework_introduction.rst

* fix pickle problem

* Update Doc &  paper

* Update docs

* Update rdagent/core/utils.py

* Update rdagent/components/coder/factor_coder/CoSTEER/knowledge_management.py
This commit is contained in:
you-n-g
2024-08-01 18:21:48 +08:00
committed by GitHub
parent bb18db0a24
commit 565f2a5f10
2 changed files with 27 additions and 16 deletions
+15 -12
View File
@@ -18,8 +18,8 @@ We believe that the automatic evolution of R&D will lead to solutions of signifi
<!-- Tag Cloud -->
R&D is a very general scenario. The advent of RDAgent can be your
- [🎥Automatic Quant Factory]()
- Data mining agent: iteratively proposing [🎥data]() & [models]() and implementing them by gaining knowledge from data.
- Research copilot: Auto read [🎥research papers]()/[🎥reports]() and implement model structures or building datasets.
- 🤖Data mining agent: iteratively proposing [🎥data]() & [models]() and implementing them by gaining knowledge from data.
- 🦾Research copilot: Auto read [🎥research papers]()/[🎥reports]() and implement model structures or building datasets.
- ...
You can click the [🎥link]() above to view the demo. More methods and scenarios are being added to the project to empower your R&D processes and boost productivity.
@@ -107,9 +107,9 @@ Here is our supported scenarios
| Scenario/Target | Model Implementation | Data Building |
| -- | -- | -- |
| 💹 Finance | Iteratively Proposing Ideas & Evolving | - Auto reports reading & implementation <br/> - Iteratively Proposing Ideas & Evolving |
| 🩺 Medical | Iteratively Proposing Ideas & Evolving | - |
| 🏭 General | Auto paper reading & implementation | - |
| 💹 Finance | 🤖Iteratively Proposing Ideas & Evolving | - 🦾Auto reports reading & implementation <br/> - 🤖Iteratively Proposing Ideas & Evolving |
| 🩺 Medical | 🤖Iteratively Proposing Ideas & Evolving | - |
| 🏭 General | 🦾Auto paper reading & implementation | - |
Different scenarios vary in entrance and configuration. Please check the detailed setup tutorial in the scenarios documents.
@@ -118,7 +118,8 @@ TODO: Scenario Gallary
# ⚙️Framework
![image](https://github.com/user-attachments/assets/c622704c-377a-4361-b956-c1eb9cf6a736)
![image](https://github.com/user-attachments/assets/98fce923-77ab-4982-93c8-a7a01aece766)
Automating the R&D process in data science is a highly valuable yet underexplored area in industry. We propose a framework to push the boundaries of this important research field.
@@ -135,13 +136,15 @@ We believe that the key to delivering high-quality solutions lies in the ability
# 📃Paper/Work list
## Benchmark
- TODO: adding link;
- [Towards Data-Centric Automatic R&D](https://arxiv.org/abs/2404.11276);
```BibTeX
@article{chen2024rd2bench,
title={RD2Bench: Toward Data-Centric Automatic R\&D},
author={Chen, Haotian and Shen, Xinjie and Ye, Zeqi and Yang, Xiao and Yang, Xu and Liu, Weiqing and Bian, Jiang},
journal={arXiv preprint arXiv:2404.11276},
year={2024}
@misc{chen2024datacentric,
title={Towards Data-Centric Automatic R&D},
author={Haotian Chen and Xinjie Shen and Zeqi Ye and Wenjun Feng and Haoxue Wang and Xiao Yang and Xu Yang and Weiqing Liu and Jiang Bian},
year={2024},
eprint={2404.11276},
archivePrefix={arXiv},
primaryClass={cs.AI}
}
```
![image](https://github.com/user-attachments/assets/494f55d3-de9e-4e73-ba3d-a787e8f9e841)
+12 -4
View File
@@ -5,11 +5,19 @@ Framework Design & Components
Framework & Components
=========================
- TODO: Components & Feature Level
![image](https://github.com/user-attachments/assets/c622704c-377a-4361-b956-c1eb9cf6a736)
.. NOTE: This depends on the correctness of `c-v` of github.
.. image:: https://github.com/user-attachments/assets/98fce923-77ab-4982-93c8-a7a01aece766
:alt: Components & Feature Level
The image above shows the overall framework of RDAgent.
.. image:: https://github.com/user-attachments/assets/60cc2712-c32a-4492-a137-8aec59cdc66e
:alt: Class Level Figure
For those interested in the detailed code, the figure above illustrates the main classes and aligns them with the workflow.
- Class Level Figure
![image](https://github.com/user-attachments/assets/60cc2712-c32a-4492-a137-8aec59cdc66e)
Detailed Design
=========================