Triangle104 commited on
Commit
756f818
1 Parent(s): 754a3b9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -84
README.md CHANGED
@@ -17,123 +17,77 @@ This model was converted to GGUF format from [`allenai/Llama-3.1-Tulu-3-8B`](htt
17
  Refer to the [original model card](https://huggingface.co/allenai/Llama-3.1-Tulu-3-8B) for more details on the model.
18
 
19
  ---
 
 
 
20
 
 
21
 
22
- The chat template for our models is formatted as:
23
 
 
24
 
25
- <|user|>\nHow are you doing?\n<|assistant|>\nI'm just a computer program, so I don't have feelings, but I'm functioning as expected. How can I assist you today?<|endoftext|>
26
 
27
- Or with new lines expanded:
28
 
29
- <|user|>
30
- How are you doing?
31
- <|assistant|>
32
- I'm just a computer program, so I don't have feelings, but I'm functioning as expected. How can I assist you today?<|endoftext|>
33
 
34
- It is embedded within the tokenizer as well, for tokenizer.apply_chat_template.
35
 
36
- System prompt
37
-
38
 
 
39
 
 
40
 
41
- In Ai2 demos, we use this system prompt by default:
42
 
 
43
 
44
- You are Tulu 3, a helpful and harmless AI Assistant built by the Allen Institute for AI.
45
 
46
- The model has not been trained with a specific system prompt in mind.
 
 
 
 
47
 
48
- Bias, Risks, and Limitations
49
-
50
 
 
51
 
 
52
 
53
- The Tülu3 models have limited safety training, but are not deployed
54
- automatically with in-the-loop filtering of responses like ChatGPT, so
55
- the model can produce problematic outputs (especially when prompted to
56
- do so).
57
- It is also unknown what the size and composition of the corpus was used
58
- to train the base Llama 3.1 models, however it is likely to have
59
- included a mix of Web data and technical sources like books and code.
60
- See the Falcon 180B model card for an example of this.
61
 
62
- Hyperparamters
63
 
64
- PPO settings for RLVR:
65
 
66
- Learning Rate: 3 × 10⁻⁷
67
- Discount Factor (gamma): 1.0
68
- General Advantage Estimation (lambda): 0.95
69
- Mini-batches (N_mb): 1
70
- PPO Update Iterations (K): 4
71
- PPO's Clipping Coefficient (epsilon): 0.2
72
- Value Function Coefficient (c1): 0.1
73
- Gradient Norm Threshold: 1.0
74
- Learning Rate Schedule: Linear
75
- Generation Temperature: 1.0
76
- Batch Size (effective): 512
77
- Max Token Length: 2,048
78
- Max Prompt Token Length: 2,048
79
- Penalty Reward Value for Responses without an EOS Token: -10.0
80
- Response Length: 1,024 (but 2,048 for MATH)
81
- Total Episodes: 100,000
82
- KL penalty coefficient (beta): [0.1, 0.05, 0.03, 0.01]
83
- Warm up ratio (omega): 0.0
84
 
85
- License and use
86
-
87
 
 
88
 
 
89
 
90
- All Llama 3.1 Tülu3 models are released under Meta's Llama 3.1 Community License Agreement.
91
- Llama 3.1 is licensed under the Llama 3.1 Community License, Copyright © Meta Platforms, Inc.
92
- Tülu3 is intended for research and educational use.
93
- For more information, please see our Responsible Use Guidelines.
94
 
 
95
 
96
- The models have been fine-tuned using a dataset mix with outputs
97
- generated from third party models and are subject to additional terms:
98
- Gemma Terms of Use and Qwen License Agreement (models were improved using Qwen 2.5).
99
 
100
- Citation
101
-
102
 
 
103
 
 
104
 
105
  If Tülu3 or any of the related materials were helpful to your work, please cite:
106
 
107
- @article{lambert2024tulu3,
108
- title = {Tülu 3: Pushing Frontiers in Open Language Model Post-Training},
109
- author = {
110
- Nathan Lambert and
111
- Jacob Morrison and
112
- Valentina Pyatkin and
113
- Shengyi Huang and
114
- Hamish Ivison and
115
- Faeze Brahman and
116
- Lester James V. Miranda and
117
- Alisa Liu and
118
- Nouha Dziri and
119
- Shane Lyu and
120
- Yuling Gu and
121
- Saumya Malik and
122
- Victoria Graf and
123
- Jena D. Hwang and
124
- Jiangjiang Yang and
125
- Ronan Le Bras and
126
- Oyvind Tafjord and
127
- Chris Wilhelm and
128
- Luca Soldaini and
129
- Noah A. Smith and
130
- Yizhong Wang and
131
- Pradeep Dasigi and
132
- Hannaneh Hajishirzi
133
- },
134
- year = {2024},
135
- email = {tulu@allenai.org}
136
- }
137
 
138
  ---
139
  ## Use with llama.cpp
 
17
  Refer to the [original model card](https://huggingface.co/allenai/Llama-3.1-Tulu-3-8B) for more details on the model.
18
 
19
  ---
20
+ Model details:
21
+ -
22
+ Tülu3 is a leading instruction following model family, offering fully open-source data, code, and recipes designed to serve as a comprehensive guide for modern post-training techniques. Tülu3 is designed for state-of-the-art performance on a diversity of tasks in addition to chat, such as MATH, GSM8K, and IFEval.
23
 
24
+ Model description
25
 
26
+ Model type: A model trained on a mix of publicly available, synthetic and human-created datasets. Language(s) (NLP): Primarily English License: Llama 3.1 Community License Agreement Finetuned from model: allenai/Llama-3.1-Tulu-3-8B-DPO
27
 
28
+ Model Sources
29
 
30
+ Training Repository: https://github.com/allenai/open-instruct Eval Repository: https://github.com/allenai/olmes Paper: https://arxiv.org/abs/2411.15124 Demo: https://playground.allenai.org/
31
 
32
+ Using the model
33
 
34
+ Loading with HuggingFace
 
 
 
35
 
36
+ To load the model with HuggingFace, use the following snippet:
37
 
38
+ from transformers import AutoModelForCausalLM
 
39
 
40
+ tulu_model = AutoModelForCausalLM.from_pretrained("allenai/Llama-3.1-Tulu-3-8B")
41
 
42
+ VLLM
43
 
44
+ As a Llama base model, the model can be easily served with:
45
 
46
+ vllm serve allenai/Llama-3.1-Tulu-3-8B
47
 
48
+ Note that given the long chat template of Llama, you may want to use --max_model_len=8192.
49
 
50
+ Chat template
51
+
52
+ The chat template for our models is formatted as:
53
+
54
+ <|user|>\nHow are you doing?\n<|assistant|>\nI'm just a computer program, so I don't have feelings, but I'm functioning as expected. How can I assist you today?<|endoftext|>
55
 
56
+ Or with new lines expanded:
 
57
 
58
+ <|user|> How are you doing? <|assistant|> I'm just a computer program, so I don't have feelings, but I'm functioning as expected. How can I assist you today?<|endoftext|>
59
 
60
+ It is embedded within the tokenizer as well, for tokenizer.apply_chat_template.
61
 
62
+ System prompt
 
 
 
 
 
 
 
63
 
64
+ In Ai2 demos, we use this system prompt by default:
65
 
66
+ You are Tulu 3, a helpful and harmless AI Assistant built by the Allen Institute for AI.
67
 
68
+ The model has not been trained with a specific system prompt in mind.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
+ Bias, Risks, and Limitations
 
71
 
72
+ The Tülu3 models have limited safety training, but are not deployed automatically with in-the-loop filtering of responses like ChatGPT, so the model can produce problematic outputs (especially when prompted to do so). It is also unknown what the size and composition of the corpus was used to train the base Llama 3.1 models, however it is likely to have included a mix of Web data and technical sources like books and code. See the Falcon 180B model card for an example of this.
73
 
74
+ Hyperparamters
75
 
76
+ PPO settings for RLVR:
 
 
 
77
 
78
+ Learning Rate: 3 × 10⁻⁷ Discount Factor (gamma): 1.0 General Advantage Estimation (lambda): 0.95 Mini-batches (N_mb): 1 PPO Update Iterations (K): 4 PPO's Clipping Coefficient (epsilon): 0.2 Value Function Coefficient (c1): 0.1 Gradient Norm Threshold: 1.0 Learning Rate Schedule: Linear Generation Temperature: 1.0 Batch Size (effective): 512 Max Token Length: 2,048 Max Prompt Token Length: 2,048 Penalty Reward Value for Responses without an EOS Token: -10.0 Response Length: 1,024 (but 2,048 for MATH) Total Episodes: 100,000 KL penalty coefficient (beta): [0.1, 0.05, 0.03, 0.01] Warm up ratio (omega): 0.0
79
 
80
+ License and use
 
 
81
 
82
+ All Llama 3.1 Tülu3 models are released under Meta's Llama 3.1 Community License Agreement. Llama 3.1 is licensed under the Llama 3.1 Community License, Copyright © Meta Platforms, Inc. Tülu3 is intended for research and educational use. For more information, please see our Responsible Use Guidelines.
 
83
 
84
+ The models have been fine-tuned using a dataset mix with outputs generated from third party models and are subject to additional terms: Gemma Terms of Use and Qwen License Agreement (models were improved using Qwen 2.5).
85
 
86
+ Citation
87
 
88
  If Tülu3 or any of the related materials were helpful to your work, please cite:
89
 
90
+ @article{lambert2024tulu3, title = {Tülu 3: Pushing Frontiers in Open Language Model Post-Training}, author = { Nathan Lambert and Jacob Morrison and Valentina Pyatkin and Shengyi Huang and Hamish Ivison and Faeze Brahman and Lester James V. Miranda and Alisa Liu and Nouha Dziri and Shane Lyu and Yuling Gu and Saumya Malik and Victoria Graf and Jena D. Hwang and Jiangjiang Yang and Ronan Le Bras and Oyvind Tafjord and Chris Wilhelm and Luca Soldaini and Noah A. Smith and Yizhong Wang and Pradeep Dasigi and Hannaneh Hajishirzi }, year = {2024}, email = {tulu@allenai.org} }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
91
 
92
  ---
93
  ## Use with llama.cpp