IvanHU commited on
Commit
eb753da
·
1 Parent(s): f49ad04

Update README

Browse files
Files changed (1) hide show
  1. README.md +38 -0
README.md CHANGED
@@ -8,6 +8,15 @@ Both [**YuLan-Mini**](https://huggingface.co/yulan-team/YuLan-Mini) and **YuLan-
8
 
9
  This version includes the optimizer, allowing you to resume training using the Hugging Face Trainer and DeepSpeed Universal Checkpoint.
10
 
 
 
 
 
 
 
 
 
 
11
  ## Continual Training Tutorial
12
 
13
  ### Step 1: Modify the `config.json`
@@ -106,3 +115,32 @@ trainer.train(resume_from_checkpoint=training_args.resume_from_checkpoint)
106
 
107
  We provide an internal [training framework](https://github.com/RUC-GSAI/YuLan-Mini/tree/main/pretrain) for your reference, but you are free to choose other frameworks.
108
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
 
9
  This version includes the optimizer, allowing you to resume training using the Hugging Face Trainer and DeepSpeed Universal Checkpoint.
10
 
11
+ ## What you can do with these pre-training resources
12
+
13
+ 1. **Pre-train** your own LLM. You can use [our data](https://huggingface.co/yulan-team/YuLan-Mini-Datasets) and curriculum to train a model that's just as powerful as YuLan-Mini.
14
+ 2. Perform your own **learning rate annealing**. During the annealing phase, YuLan-Mini's learning ability is at its peak. You can resume training from [the checkpoint before annealing](https://huggingface.co/yulan-team/YuLan-Mini-Before-Annealing) and use your own dataset for learning rate annealing.
15
+ 3. **Fine-tune** the Instruct version of the LLM. You can use the YuLan-Mini base model to train your own Instruct version.
16
+ 4. **Training dynamics** research. You can use YuLan-Mini's intermediate checkpoints to explore internal changes during the pre-training process.
17
+ 5. **Synthesize** your own data. You can use YuLan-Mini's [data pipeline](https://github.com/RUC-GSAI/YuLan-Mini) to clean and generate your own dataset.
18
+
19
+
20
  ## Continual Training Tutorial
21
 
22
  ### Step 1: Modify the `config.json`
 
115
 
116
  We provide an internal [training framework](https://github.com/RUC-GSAI/YuLan-Mini/tree/main/pretrain) for your reference, but you are free to choose other frameworks.
117
 
118
+
119
+ ---
120
+
121
+ ## The Team
122
+
123
+ YuLan-Mini is developed and maintained by [AI Box, Renmin University of China](http://aibox.ruc.edu.cn/).
124
+
125
+ ## License
126
+
127
+ - The code in this repository is released under the [MIT License](./LICENSE).
128
+ - Policies regarding the use of model weights, intermediate optimizer states, and training data will be announced in future updates.
129
+ - Limitations: Despite our efforts to mitigate safety concerns and encourage the generation of ethical and lawful text, the probabilistic nature of language models may still lead to unexpected outputs. For instance, responses might contain bias, discrimination, or other harmful content. Please refrain from disseminating such content. We are not liable for any consequences arising from the spread of harmful information.
130
+
131
+ ## Citation
132
+
133
+ If you find YuLan-Mini helpful for your research or development, please cite [our technical report](https://arxiv.org/abs/2412.17743):
134
+
135
+ ```
136
+ @misc{hu2024yulanmini,
137
+ title={YuLan-Mini: An Open Data-efficient Language Model},
138
+ author={Yiwen Hu and Huatong Song and Jia Deng and Jiapeng Wang and Jie Chen and Kun Zhou and Yutao Zhu and Jinhao Jiang and Zican Dong and Wayne Xin Zhao and Ji-Rong Wen},
139
+ year={2024},
140
+ eprint={2412.17743},
141
+ archivePrefix={arXiv},
142
+ primaryClass={cs.CL},
143
+ url={https://arxiv.org/abs/2412.17743},
144
+ }
145
+ ```
146
+