Text Generation
Transformers
PyTorch
English
olmo2
conversational
Inference Endpoints
hamishivi commited on
Commit
13e7e6b
·
verified ·
1 Parent(s): 9d32ad0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +84 -179
README.md CHANGED
@@ -1,215 +1,120 @@
1
  ---
2
- language: en
3
- model-index:
4
- - name: allenai/open_instruct_dev
5
- results:
6
- - task:
7
- type: preference_evaluation
8
- dataset:
9
- name: reward-bench
10
- type: allenai/reward-bench
11
- metrics:
12
- - type: accuracy
13
- value: 1.0
14
- - type: accuracy
15
- value: 1.0
16
- - type: accuracy
17
- value: 1.0
18
- - type: accuracy
19
- value: 1.0
20
  ---
21
 
22
- # Model Card for allenai/open_instruct_dev
23
 
24
- <!-- Provide a quick summary of what the model is/does. -->
25
 
 
 
 
26
 
 
 
 
27
 
28
- ## Model Details
 
 
 
29
 
30
- ### Model Description
31
 
32
- <!-- Provide a longer summary of what this model is. -->
33
 
34
 
 
35
 
36
- - **Developed by:** [More Information Needed]
37
- - **Funded by [optional]:** [More Information Needed]
38
- - **Shared by [optional]:** [More Information Needed]
39
- - **Model type:** [More Information Needed]
40
- - **Language(s) (NLP):** en
41
- - **License:** [More Information Needed]
42
- - **Finetuned from model [optional]:** [More Information Needed]
43
 
44
- ### Model Sources [optional]
45
 
46
- <!-- Provide the basic links for the model. -->
 
 
 
 
 
 
47
 
48
- - **Repository:** [More Information Needed]
49
- - **Paper [optional]:** [More Information Needed]
50
- - **Demo [optional]:** [More Information Needed]
51
 
52
- ## Uses
53
 
54
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
55
 
56
- ### Direct Use
57
 
58
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
59
 
60
- [More Information Needed]
 
61
 
62
- ### Downstream Use [optional]
63
 
64
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 
 
 
 
 
 
 
 
 
 
65
 
66
- [More Information Needed]
67
 
68
- ### Out-of-Scope Use
 
 
 
 
69
 
70
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
71
 
72
- [More Information Needed]
 
73
 
74
- ## Bias, Risks, and Limitations
75
 
76
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
77
 
78
- [More Information Needed]
79
 
80
- ### Recommendations
81
 
82
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
83
 
84
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 
 
 
 
 
 
85
 
86
- ## How to Get Started with the Model
87
 
88
- Use the code below to get started with the model.
 
 
89
 
90
- [More Information Needed]
91
 
92
- ## Training Details
93
-
94
- ### Training Data
95
-
96
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
97
-
98
- [More Information Needed]
99
-
100
- ### Training Procedure
101
-
102
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
103
-
104
- #### Preprocessing [optional]
105
-
106
- [More Information Needed]
107
-
108
-
109
- #### Training Hyperparameters
110
-
111
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
112
-
113
- #### Speeds, Sizes, Times [optional]
114
-
115
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
116
-
117
- [More Information Needed]
118
-
119
- ## Evaluation
120
-
121
- <!-- This section describes the evaluation protocols and provides the results. -->
122
-
123
- ### Testing Data, Factors & Metrics
124
-
125
- #### Testing Data
126
-
127
- <!-- This should link to a Dataset Card if possible. -->
128
-
129
- [More Information Needed]
130
-
131
- #### Factors
132
-
133
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
134
-
135
- [More Information Needed]
136
-
137
- #### Metrics
138
-
139
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
140
-
141
- [More Information Needed]
142
-
143
- ### Results
144
-
145
- [More Information Needed]
146
-
147
- #### Summary
148
-
149
-
150
-
151
- ## Model Examination [optional]
152
-
153
- <!-- Relevant interpretability work for the model goes here -->
154
-
155
- [More Information Needed]
156
-
157
- ## Environmental Impact
158
-
159
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
160
-
161
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
162
-
163
- - **Hardware Type:** [More Information Needed]
164
- - **Hours used:** [More Information Needed]
165
- - **Cloud Provider:** [More Information Needed]
166
- - **Compute Region:** [More Information Needed]
167
- - **Carbon Emitted:** [More Information Needed]
168
-
169
- ## Technical Specifications [optional]
170
-
171
- ### Model Architecture and Objective
172
-
173
- [More Information Needed]
174
-
175
- ### Compute Infrastructure
176
-
177
- [More Information Needed]
178
-
179
- #### Hardware
180
-
181
- [More Information Needed]
182
-
183
- #### Software
184
-
185
- [More Information Needed]
186
-
187
- ## Citation [optional]
188
-
189
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
190
-
191
- **BibTeX:**
192
-
193
- [More Information Needed]
194
-
195
- **APA:**
196
-
197
- [More Information Needed]
198
-
199
- ## Glossary [optional]
200
-
201
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
202
-
203
- [More Information Needed]
204
-
205
- ## More Information [optional]
206
-
207
- [More Information Needed]
208
-
209
- ## Model Card Authors [optional]
210
-
211
- [More Information Needed]
212
-
213
- ## Model Card Contact
214
-
215
- [More Information Needed]
 
1
  ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ pipeline_tag: text-generation
6
+ base_model:
7
+ - allenai/OLMo2-7B-1124
8
+ library_name: transformers
 
 
 
 
 
 
 
 
 
 
 
9
  ---
10
 
11
+ <img src="https://allenai.org/olmo/olmo-7b-animation.gif" alt="OLMo Logo" width="800" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
12
 
13
+ # OLMo-2-1124-7B-SFT
14
 
15
+ OLMo2 7B SFT November 2024 is finetuned variant of the [OLMo2-7B November 2024](https://huggingface.co/allenai/OLMo2-7B-1124) model, which has undergone supervised finetuning on the [Tülu 3 dataset](https://huggingface.co/datasets/allenai/tulu-3-sft-mixture).
16
+ Tülu 3 is designed for state-of-the-art performance on a diversity of tasks in addition to chat, such as MATH, GSM8K, and IFEval.
17
+ We use a
18
 
19
+ OLMo is a series of **O**pen **L**anguage **Mo**dels designed to enable the science of language models.
20
+ These models are trained on the Dolma dataset. We are releasing all code, checkpoints, logs (coming soon), and associated training details.
21
+ The core models released in this batch include the following:
22
 
23
+ | Size | Training Tokens | Layers | Hidden Size | Attention Heads | Context Length |
24
+ |------|--------|---------|-------------|-----------------|----------------|
25
+ | [OLMo2-7B July 2024](https://huggingface.co/allenai/OLMo-7B-0724-hf) | 4 Trillion | 32 | 4096 | 32 | 4096 |
26
+ | [OLMo2- 13B July 2024](https://huggingface.co/allenai/OLMo-1B-0724-hf) | 5 Trillion | 40 | 5120 | 42 | 4096 |
27
 
 
28
 
 
29
 
30
 
31
+ ## Model description
32
 
33
+ - **Model type:** A model trained on a mix of publicly available, synthetic and human-created datasets.
34
+ - **Language(s) (NLP):** Primarily English
35
+ - **License:** Apache 2.0
36
+ - **Finetuned from model:** allenai/OLMo2-7B-1124
 
 
 
37
 
38
+ ### Model Sources
39
 
40
+ - **Project Page:** https://allenai.org/olmo
41
+ - **Repositories:**
42
+ - Core repo (training, inference, fine-tuning etc.): https://github.com/allenai/OLMo
43
+ - Evaluation code: https://github.com/allenai/olmes
44
+ - Further fine-tuning code: https://github.com/allenai/open-instruct
45
+ - **Paper:** Coming soon!
46
+ - **Demo:** https://playground.allenai.org/
47
 
48
+ ### Model Family
 
 
49
 
50
+ TODO
51
 
52
+ ## Using the model
53
 
54
+ ### Loading with HuggingFace
55
 
56
+ To load the model with HuggingFace, use the following snippet:
57
+ ```
58
+ from transformers import AutoModelForCausalLM
59
 
60
+ olmo_model = AutoModelForCausalLM.from_pretrained("allenai/OLMo-2-1124-7B-SFT")
61
+ ```
62
 
63
+ ### Chat template
64
 
65
+ The chat template for our models is formatted as:
66
+ ```
67
+ <|endoftext|><|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|>
68
+ ```
69
+ Or with new lines expanded:
70
+ ```
71
+ <|endoftext|><|user|>
72
+ How are you doing?
73
+ <|assistant|>
74
+ 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|>
75
+ ```
76
+ It is embedded within the tokenizer as well, for `tokenizer.apply_chat_template`.
77
 
78
+ ### System prompt
79
 
80
+ In Ai2 demos, we use this system prompt by default:
81
+ ```
82
+ You are OLMo 2, a helpful and harmless AI Assistant built by the Allen Institute for AI.
83
+ ```
84
+ The model has not been trained with a specific system prompt in mind.
85
 
86
+ ### Bias, Risks, and Limitations
87
 
88
+ The OLMo2 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).
89
+ See the Falcon 180B model card for an example of this.
90
 
 
91
 
92
+ ## Performance
93
 
94
+ TODO
95
 
96
+ ## Hyperparamters
97
 
98
+ TODO: check
99
 
100
+ SFT:
101
+ - **Learning Rate**: 5E-6 (8B), 2E-6 (70B)
102
+ - **Effective Batch Size:** 128
103
+ - **Max. Sequence Length:** 4096
104
+ - **Loss Accumulation:** Sum (see https://unsloth.ai/blog/gradient)
105
+ - **Learning Rate Schedule:** Linear
106
+ - **LR Warmup Ratio:** 0.03
107
+ - **Num. Epochs:** 2
108
 
109
+ ## License and use
110
 
111
+ OLMo2 is licensed under the Apache 2.0 license.
112
+ OLMo2 is intended for research and educational use.
113
+ For more information, please see our [Responsible Use Guidelines](https://allenai.org/responsible-use).
114
 
115
+ ## Citation
116
 
117
+ If OLMo2 or any of the related materials were helpful to your work, please cite:
118
+ ```
119
+ TODO
120
+ ```