Skip to content

Commit

Permalink
update readme (#194)
Browse files Browse the repository at this point in the history
Co-authored-by: you-n-g <[email protected]>
  • Loading branch information
WinstonLiyt and you-n-g authored Aug 9, 2024
1 parent 34b7087 commit 95439a1
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,16 @@ You can try our demo by running the following command:
conda activate rdagent
```

### 🛠️ Install from pip
### 🛠️ Install the RDAgent
- You can directly install the RDAgent package from PyPI:
```sh
pip install rdagent
```


### 🛠️ Run Make Files

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

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

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

- Run the Qlib self-loop factor proposal and implementation application:
- Run the **Automated Quantitative Trading & Iterative Model Evolution**: Qlib self-loop model proposal and implementation application
```sh
rdagent fin_factor
python fin_model
```

- Run the Qlib self-loop model proposal and implementation application:
- Run the **Automated Medical Predtion Model Evolution**: medical self-loop model proposal and implementation application
```sh
rdagent fin_model
python med_model
```

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

- Run the medical self-loop model proposal and implementation application:
- Run the **Automated Model Research & Development Co-Pilot**: model extraction and implementation application
```sh
rdagent med_model
rdagent general_model <Your paper url>
```


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

0 comments on commit 95439a1

Please sign in to comment.