Skip to content

Commit 95439a1

Browse files
WinstonLiytyou-n-g
andauthored
update readme (#194)
Co-authored-by: you-n-g <[email protected]>
1 parent 34b7087 commit 95439a1

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,16 @@ You can try our demo by running the following command:
5555
conda activate rdagent
5656
```
5757

58-
### 🛠️ Install from pip
58+
### 🛠️ Install the RDAgent
59+
- You can directly install the RDAgent package from PyPI:
5960
```sh
6061
pip install rdagent
6162
```
63+
64+
6265
### 🛠️ Run Make Files
6366

64-
- **Navigate to the directory containing the MakeFile** and set up the development environment:
67+
- If you want to use our project in development mode. **Navigate to the directory containing the MakeFile** and set up the development environment:
6568
```sh
6669
make dev
6770
```
@@ -79,31 +82,30 @@ You can try our demo by running the following command:
7982

8083
The [🎥demo](https://rdagent.azurewebsites.net) is implemented by the following commands:
8184

82-
- Run the Qlib factor extraction and implementation application based on financial reports:
85+
- Run the **Automated Quantitative Trading & Iterative Factors Evolution**: Qlib self-loop factor proposal and implementation application
8386
```sh
84-
rdagent fin_factor_report <Your report folder>
87+
rdagent fin_factor
8588
```
8689

87-
- Run the Qlib self-loop factor proposal and implementation application:
90+
- Run the **Automated Quantitative Trading & Iterative Model Evolution**: Qlib self-loop model proposal and implementation application
8891
```sh
89-
rdagent fin_factor
92+
python fin_model
9093
```
9194

92-
- Run the Qlib self-loop model proposal and implementation application:
95+
- Run the **Automated Medical Predtion Model Evolution**: medical self-loop model proposal and implementation application
9396
```sh
94-
rdagent fin_model
97+
python med_model
9598
```
9699

97-
- Run the model extraction and implementation application:
100+
- Run the **Automated Quantitative Trading & Factors Extraction from Financial Reports**: Run the Qlib factor extraction and implementation application based on financial reports
98101
```sh
99-
rdagent general_model <Your paper url>
102+
rdagent fin_factor_report <Your report folder>
100103
```
101104

102-
- Run the medical self-loop model proposal and implementation application:
105+
- Run the **Automated Model Research & Development Co-Pilot**: model extraction and implementation application
103106
```sh
104-
rdagent med_model
107+
rdagent general_model <Your paper url>
105108
```
106-
107109

108110
### 🚀 Monitor the Application
109111
- You can serve our demo app to monitor the RD loop by running the following command:

0 commit comments

Comments
 (0)