You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-10Lines changed: 28 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,10 +37,10 @@ R&D is a very general scenario. The advent of RDAgent can be your
37
37
- ...
38
38
39
39
You can click the [🎥link](https://rdagent.azurewebsites.net) above to view the demo. More methods and scenarios are being added to the project to empower your R&D processes and boost productivity.
40
-
40
+
<!--
41
41
We have a quick 🎥demo for one use case of RDAgent.
42
42
- TODO: Demo
43
-
43
+
-->
44
44
45
45
# ⚡Quick start
46
46
You can try our demo by running the following command:
@@ -55,8 +55,11 @@ You can try our demo by running the following command:
55
55
conda activate rdagent
56
56
```
57
57
58
+
### 🛠️ Install from pip
59
+
```sh
60
+
pip install rdagent
61
+
```
58
62
### 🛠️ Run Make Files
59
-
TODO: `pip install rdagent` in the future.
60
63
61
64
-**Navigate to the directory containing the MakeFile** and set up the development environment:
62
65
```sh
@@ -69,25 +72,40 @@ TODO: `pip install rdagent` in the future.
69
72
- The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
70
73
- please refer to [Configuration](docs/build/html/installation.html#azure-openai) for the detailed explanation of the `.env`
71
74
### 🚀 Run the Application
72
-
TODO: run the front-page demo.
73
75
74
76
The [🎥demo](https://rdagent.azurewebsites.net) is implemented by the following commands:
75
77
76
-
- Run the factor extraction and implementation application based on financial reports:
78
+
- Run the Qlib factor extraction and implementation application based on financial reports:
77
79
```sh
78
-
rdagent fin_factor_report
80
+
rdagent fin_factor_report<Your report folder>
79
81
```
80
82
81
-
- Run the self-loop factor extraction and implementation application:
83
+
- Run the Qlib self-loop factor proposal and implementation application:
82
84
```sh
83
-
python rdagent/app/qlib_rd_loop/factor.py
85
+
rdagent fin_factor
84
86
```
85
87
86
-
- Run the self-loop model extraction and implementation application:
88
+
- Run the Qlib self-loop model proposal and implementation application:
87
89
```sh
88
-
python rdagent/app/qlib_rd_loop/model.py
90
+
rdagent fin_model
89
91
```
90
92
93
+
- Run the model extraction and implementation application:
94
+
```sh
95
+
rdagent general_model <Your paper url>
96
+
```
97
+
98
+
- Run the medical self-loop model proposal and implementation application:
99
+
```sh
100
+
rdagent med_model
101
+
```
102
+
103
+
104
+
### 🚀 Monitor the Application
105
+
You can serve our demo app to monitor the RD loop by running the following command:
0 commit comments