diff --git a/README.md b/README.md index 17b42ba97d..4429ba7f49 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,16 @@ Trinity-RFT -   +
+ +[![paper](http://img.shields.io/badge/cs.LG-2505.17826-B31B1B?logo=arxiv&logoColor=red)](https://arxiv.org/abs/2505.17826) +[![doc](https://img.shields.io/badge/Docs-blue?logo=markdown)](https://modelscope.github.io/Trinity-RFT/) +[![pypi](https://img.shields.io/pypi/v/trinity-rft?logo=pypi&color=026cad)](https://pypi.org/project/trinity-rft/0.1.0/) +![license](https://img.shields.io/badge/license-Apache--2.0-000000.svg) + +
**Trinity-RFT is a general-purpose, flexible, scalable and user-friendly framework designed for reinforcement fine-tuning (RFT) of large language models (LLM).** @@ -146,6 +153,12 @@ pip install flash-attn -v # pip install flash-attn -v --no-build-isolation ``` +Installation using pip: + +```shell +pip install trinity-rft==0.1.0 +``` + Installation from docker: we have provided a dockerfile for Trinity-RFT (trinity) @@ -332,10 +345,13 @@ This project is built upon many excellent open-source projects, including: ## Citation ```plain -@misc{Trinity-RFT, - title={Trinity-RFT}, - author={{Trinity-RFT Team}}, - url={https://github.com/modelscope/trinity-rft}, - year={2025}, +@misc{trinity-rft, + title={Trinity-RFT: A General-Purpose and Unified Framework for Reinforcement Fine-Tuning of Large Language Models}, + author={Xuchen Pan and Yanxi Chen and Yushuo Chen and Yuchang Sun and Daoyuan Chen and Wenhao Zhang and Yuexiang Xie and Yilun Huang and Yilei Zhang and Dawei Gao and Yaliang Li and Bolin Ding and Jingren Zhou}, + year={2025}, + eprint={2505.17826}, + archivePrefix={arXiv}, + primaryClass={cs.LG}, + url={https://arxiv.org/abs/2505.17826}, } ``` diff --git a/docs/sphinx_doc/assets/trinity-design.png b/docs/sphinx_doc/assets/trinity-design.png index af94b860a3..a9dc7e3676 100644 Binary files a/docs/sphinx_doc/assets/trinity-design.png and b/docs/sphinx_doc/assets/trinity-design.png differ diff --git a/docs/sphinx_doc/source/main.md b/docs/sphinx_doc/source/main.md index 737e370570..4992854eef 100644 --- a/docs/sphinx_doc/source/main.md +++ b/docs/sphinx_doc/source/main.md @@ -124,6 +124,11 @@ pip install flash-attn -v # pip install flash-attn -v --no-build-isolation ``` +Installation using pip: + +```shell +pip install trinity-rft==0.1.0 +``` Installation from docker: we have provided a dockerfile for Trinity-RFT (trinity) @@ -319,10 +324,13 @@ This project is built upon many excellent open-source projects, including: ## Citation ``` -@misc{Trinity-RFT, - title={Trinity-RFT}, - author={{Trinity-RFT Team}}, - url={https://github.com/modelscope/trinity-rft}, - year={2025}, +@misc{trinity-rft, + title={Trinity-RFT: A General-Purpose and Unified Framework for Reinforcement Fine-Tuning of Large Language Models}, + author={Xuchen Pan and Yanxi Chen and Yushuo Chen and Yuchang Sun and Daoyuan Chen and Wenhao Zhang and Yuexiang Xie and Yilun Huang and Yilei Zhang and Dawei Gao and Yaliang Li and Bolin Ding and Jingren Zhou}, + year={2025}, + eprint={2505.17826}, + archivePrefix={arXiv}, + primaryClass={cs.LG}, + url={https://arxiv.org/abs/2505.17826}, } ```