Skip to content

Commit ef60632

Browse files
committed
Finalize main readme
1 parent 649b049 commit ef60632

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11

2-
3-
<!-- ![trinity-rft](./docs/sphinx_doc/assets/trinity-title.png) -->
4-
52
<div align="center">
63
<img src="https://img.alicdn.com/imgextra/i1/O1CN01lvLpfw25Pl4ohGZnU_!!6000000007519-2-tps-1628-490.png" alt="Trinity-RFT" style="height: 120px;">
74
</div>
85

9-
<!-- &nbsp; -->
106

117

128
<h2 align="center">Trinity-RFT: A General-Purpose and Unified Framework for Reinforcement Fine-Tuning of Large Language Models</h2>
@@ -109,14 +105,9 @@ It is designed to support diverse application scenarios and serve as a unified p
109105

110106

111107

112-
113-
114-
115108
## 🛠️ What can I use Trinity-RFT for?
116109

117110

118-
119-
120111
* **Adaptation to New Scenarios:**
121112

122113
Implement agent-environment interaction logic in a single `Workflow` or `MultiTurnWorkflow` class. ([Example](./docs/sphinx_doc/source/tutorial/example_multi_turn.md))
@@ -165,7 +156,7 @@ It is designed to support diverse application scenarios and serve as a unified p
165156
### Step 1: preparations
166157

167158

168-
**Installation from source (recommended):**
159+
Installation from source **(recommended)**:
169160

170161
```shell
171162
# Pull the source code from GitHub
@@ -197,13 +188,13 @@ pip install -e .\[flash_attn\]
197188
# pip install flash-attn -v --no-build-isolation
198189
```
199190

200-
**Installation using pip:**
191+
Installation using pip:
201192

202193
```shell
203194
pip install trinity-rft==0.2.0
204195
```
205196

206-
**Installation from docker:**
197+
Installation from docker:
207198
we have provided a dockerfile for Trinity-RFT (trinity)
208199

209200
```shell
@@ -269,7 +260,7 @@ Trinity-RFT provides a web interface for configuring your RFT process.
269260
> This is an experimental feature, and we will continue to improve it.
270261
271262

272-
To enable *minimal* features (mainly for trainer), you can run
263+
To enable minimal features (mainly for trainer), you can run
273264

274265
```bash
275266
trinity studio --port 8080
@@ -280,14 +271,14 @@ Then you can configure your RFT process in the web page and generate a config fi
280271
Advanced users can also edit the config file directly.
281272
We provide example config files in [`examples`](examples/).
282273

283-
For *complete* GUI features, please refer to the monorepo for [Trinity-Studio](https://github.com/modelscope/Trinity-Studio).
274+
For complete GUI features, please refer to the monorepo for [Trinity-Studio](https://github.com/modelscope/Trinity-Studio).
284275

285276

286277
<details>
287278

288279
<summary> Example: config manager GUI </summary>
289280

290-
![](./docs/sphinx_doc/assets/config-manager.png)
281+
![config-manager](https://img.alicdn.com/imgextra/i1/O1CN01yhYrV01lGKchtywSH_!!6000000004791-2-tps-1480-844.png)
291282

292283

293284
</details>
@@ -348,7 +339,7 @@ Tutorials for adapting Trinity-RFT to a new multi-turn agentic scenario:
348339

349340
Tutorials for data-related functionalities:
350341

351-
+ [Advanced data processing / human-in-the-loop](./docs/sphinx_doc/source/tutorial/example_data_functionalities.md)
342+
+ [Advanced data processing & human-in-the-loop](./docs/sphinx_doc/source/tutorial/example_data_functionalities.md)
352343

353344

354345
Tutorials for RL algorithm development/research with Trinity-RFT:

0 commit comments

Comments
 (0)