Skip to content

Commit ef901d8

Browse files
author
Yuanmo
committed
update README.md
1 parent a44034d commit ef901d8

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Why **RLLTE**?
5757
- ⚙️ Support custom environments and modules;
5858
- 🖥️ Support multiple computing devices like GPU and NPU;
5959
- 💾 Large number of reusable benchmarks ([RLLTE Hub](https://hub.rllte.dev));
60-
- 👨‍✈️ Large language model-empowered copilot ([RLLTE Copilot](https://github.com/RLE-Foundation/rllte-copilot)).
60+
- 🤖 Large language model-empowered copilot ([RLLTE Copilot](https://github.com/RLE-Foundation/rllte-copilot)).
6161

6262
> ⚠️ Since the construction of RLLTE Hub requires massive computing power, we have to upload the training datasets and model weights gradually. Progress report can be found in [Issue#30](https://github.com/RLE-Foundation/rllte/issues/30).
6363
@@ -136,9 +136,12 @@ device = "cuda:0" -> device = "npu:0"
136136

137137
Developers only need three steps to implement an RL algorithm with **RLLTE**. The following example illustrates how to write an Advantage Actor-Critic (A2C) agent to solve Atari games.
138138
- Firstly, select a prototype:
139-
``` py
140-
from rllte.common.prototype import OnPolicyAgent
141-
```
139+
<details>
140+
<summary>Click to expand code</summary>
141+
``` py
142+
from rllte.common.prototype import OnPolicyAgent
143+
```
144+
</details>
142145
- Secondly, select necessary modules to build the agent:
143146

144147
<details>
@@ -287,17 +290,17 @@ Explore the ecosystem of RLLTE to facilitate your project:
287290
- [Pre-training](https://docs.rllte.dev/api/tutorials/): Methods of pre-training in RL.
288291
- [Copilot](https://docs.rllte.dev/copilot): Large language model-empowered copilot.
289292

290-
# API Documentation
293+
<!-- # API Documentation
291294
View our well-designed documentation: [https://docs.rllte.dev/](https://docs.rllte.dev/)
292295
<div align=center>
293296
<img src='./docs/assets/images/docs.gif' style="width: 100%">
294-
</div>
297+
</div> -->
295298

296299
# How To Contribute
297300
Welcome to contribute to this project! Before you begin writing code, please read [CONTRIBUTING.md](https://github.com/RLE-Foundation/rllte/blob/main/CONTRIBUTING.md) for guide first.
298301

299302
# Cite the Project
300-
If you use **RLLTE** in your research, please cite this project like this:
303+
To cite this project in publications:
301304
```bibtex
302305
@article{yuan2023rllte,
303306
title={RLLTE: Long-Term Evolution Project of Reinforcement Learning},

0 commit comments

Comments
 (0)