TheBloke commited on
Commit
25b8434
1 Parent(s): a7cd1f6

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +424 -0
README.md ADDED
@@ -0,0 +1,424 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: lxuechen/phi-2-dpo
3
+ inference: false
4
+ language:
5
+ - en
6
+ license: other
7
+ license_link: https://huggingface.co/microsoft/phi-2/resolve/main/LICENSE
8
+ license_name: microsoft-research-license
9
+ model-index:
10
+ - name: phi-2-dpo
11
+ results:
12
+ - dataset:
13
+ name: AlpacaEval
14
+ type: AlpacaEval
15
+ metrics:
16
+ - name: AlpacaEval
17
+ type: AlpacaEval
18
+ value: 81.37%
19
+ source:
20
+ name: AlpacaEval
21
+ url: https://github.com/tatsu-lab/alpaca_eval
22
+ task:
23
+ type: text-generation
24
+ model_creator: Xuechen Li
25
+ model_name: Phi 2 DPO
26
+ model_type: phi-msft
27
+ pipeline_tag: text-generation
28
+ prompt_template: '### Human: {prompt}
29
+
30
+
31
+ ### Assistant:
32
+
33
+ '
34
+ quantized_by: TheBloke
35
+ tags:
36
+ - nlp
37
+ - code
38
+ ---
39
+ <!-- markdownlint-disable MD041 -->
40
+
41
+ <!-- header start -->
42
+ <!-- 200823 -->
43
+ <div style="width: auto; margin-left: auto; margin-right: auto">
44
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
45
+ </div>
46
+ <div style="display: flex; justify-content: space-between; width: 100%;">
47
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
48
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
49
+ </div>
50
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
51
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
52
+ </div>
53
+ </div>
54
+ <div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
55
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
56
+ <!-- header end -->
57
+
58
+ # Phi 2 DPO - GGUF
59
+ - Model creator: [Xuechen Li](https://huggingface.co/lxuechen)
60
+ - Original model: [Phi 2 DPO](https://huggingface.co/lxuechen/phi-2-dpo)
61
+
62
+ <!-- description start -->
63
+ ## Description
64
+
65
+ This repo contains GGUF format model files for [Xuechen Li's Phi 2 DPO](https://huggingface.co/lxuechen/phi-2-dpo).
66
+
67
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
68
+
69
+ <!-- description end -->
70
+ <!-- README_GGUF.md-about-gguf start -->
71
+ ### About GGUF
72
+
73
+ GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
74
+
75
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
76
+
77
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
78
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
79
+ * [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
80
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
81
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
82
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
83
+ * [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
84
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
85
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
86
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
87
+
88
+ <!-- README_GGUF.md-about-gguf end -->
89
+ <!-- repositories-available start -->
90
+ ## Repositories available
91
+
92
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/phi-2-dpo-GPTQ)
93
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/phi-2-dpo-GGUF)
94
+ * [Xuechen Li's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/lxuechen/phi-2-dpo)
95
+ <!-- repositories-available end -->
96
+
97
+ <!-- prompt-template start -->
98
+ ## Prompt template: SUS
99
+
100
+ ```
101
+ ### Human: {prompt}
102
+
103
+ ### Assistant:
104
+
105
+ ```
106
+
107
+ <!-- prompt-template end -->
108
+
109
+
110
+ <!-- compatibility_gguf start -->
111
+ ## Compatibility
112
+
113
+ These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
114
+
115
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
116
+
117
+ ## Explanation of quantisation methods
118
+
119
+ <details>
120
+ <summary>Click to see details</summary>
121
+
122
+ The new methods available are:
123
+
124
+ * GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
125
+ * GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
126
+ * GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
127
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
128
+ * GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
129
+
130
+ Refer to the Provided Files table below to see what files use which methods, and how.
131
+ </details>
132
+ <!-- compatibility_gguf end -->
133
+
134
+ <!-- README_GGUF.md-provided-files start -->
135
+ ## Provided files
136
+
137
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
138
+ | ---- | ---- | ---- | ---- | ---- | ----- |
139
+ | [phi-2-dpo.Q2_K.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q2_K.gguf) | Q2_K | 2 | 1.17 GB| 3.67 GB | smallest, significant quality loss - not recommended for most purposes |
140
+ | [phi-2-dpo.Q3_K_S.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q3_K_S.gguf) | Q3_K_S | 3 | 1.25 GB| 3.75 GB | very small, high quality loss |
141
+ | [phi-2-dpo.Q3_K_M.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q3_K_M.gguf) | Q3_K_M | 3 | 1.48 GB| 3.98 GB | very small, high quality loss |
142
+ | [phi-2-dpo.Q4_0.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q4_0.gguf) | Q4_0 | 4 | 1.60 GB| 4.10 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
143
+ | [phi-2-dpo.Q3_K_L.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q3_K_L.gguf) | Q3_K_L | 3 | 1.60 GB| 4.10 GB | small, substantial quality loss |
144
+ | [phi-2-dpo.Q4_K_S.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q4_K_S.gguf) | Q4_K_S | 4 | 1.61 GB| 4.11 GB | small, greater quality loss |
145
+ | [phi-2-dpo.Q4_K_M.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q4_K_M.gguf) | Q4_K_M | 4 | 1.79 GB| 4.29 GB | medium, balanced quality - recommended |
146
+ | [phi-2-dpo.Q5_0.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q5_0.gguf) | Q5_0 | 5 | 1.93 GB| 4.43 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
147
+ | [phi-2-dpo.Q5_K_S.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q5_K_S.gguf) | Q5_K_S | 5 | 1.93 GB| 4.43 GB | large, low quality loss - recommended |
148
+ | [phi-2-dpo.Q5_K_M.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q5_K_M.gguf) | Q5_K_M | 5 | 2.07 GB| 4.57 GB | large, very low quality loss - recommended |
149
+ | [phi-2-dpo.Q6_K.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q6_K.gguf) | Q6_K | 6 | 2.28 GB| 4.78 GB | very large, extremely low quality loss |
150
+ | [phi-2-dpo.Q8_0.gguf](https://huggingface.co/TheBloke/phi-2-dpo-GGUF/blob/main/phi-2-dpo.Q8_0.gguf) | Q8_0 | 8 | 2.95 GB| 5.45 GB | very large, extremely low quality loss - not recommended |
151
+
152
+ **Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
153
+
154
+
155
+
156
+ <!-- README_GGUF.md-provided-files end -->
157
+
158
+ <!-- README_GGUF.md-how-to-download start -->
159
+ ## How to download GGUF files
160
+
161
+ **Note for manual downloaders:** You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.
162
+
163
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
164
+
165
+ * LM Studio
166
+ * LoLLMS Web UI
167
+ * Faraday.dev
168
+
169
+ ### In `text-generation-webui`
170
+
171
+ Under Download Model, you can enter the model repo: TheBloke/phi-2-dpo-GGUF and below it, a specific filename to download, such as: phi-2-dpo.Q4_K_M.gguf.
172
+
173
+ Then click Download.
174
+
175
+ ### On the command line, including multiple files at once
176
+
177
+ I recommend using the `huggingface-hub` Python library:
178
+
179
+ ```shell
180
+ pip3 install huggingface-hub
181
+ ```
182
+
183
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
184
+
185
+ ```shell
186
+ huggingface-cli download TheBloke/phi-2-dpo-GGUF phi-2-dpo.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
187
+ ```
188
+
189
+ <details>
190
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
191
+
192
+ You can also download multiple files at once with a pattern:
193
+
194
+ ```shell
195
+ huggingface-cli download TheBloke/phi-2-dpo-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
196
+ ```
197
+
198
+ For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
199
+
200
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
201
+
202
+ ```shell
203
+ pip3 install hf_transfer
204
+ ```
205
+
206
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
207
+
208
+ ```shell
209
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/phi-2-dpo-GGUF phi-2-dpo.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
210
+ ```
211
+
212
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
213
+ </details>
214
+ <!-- README_GGUF.md-how-to-download end -->
215
+
216
+ <!-- README_GGUF.md-how-to-run start -->
217
+ ## Example `llama.cpp` command
218
+
219
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
220
+
221
+ ```shell
222
+ ./main -ngl 35 -m phi-2-dpo.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Human: {prompt}\n\n### Assistant:"
223
+ ```
224
+
225
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
226
+
227
+ Change `-c 2048` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
228
+
229
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
230
+
231
+ For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md)
232
+
233
+ ## How to run in `text-generation-webui`
234
+
235
+ Further instructions can be found in the text-generation-webui documentation, here: [text-generation-webui/docs/04 ‐ Model Tab.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/04%20%E2%80%90%20Model%20Tab.md#llamacpp).
236
+
237
+ ## How to run from Python code
238
+
239
+ You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries. Note that at the time of writing (Nov 27th 2023), ctransformers has not been updated for some time and is not compatible with some recent models. Therefore I recommend you use llama-cpp-python.
240
+
241
+ ### How to load this model in Python code, using llama-cpp-python
242
+
243
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
244
+
245
+ #### First install the package
246
+
247
+ Run one of the following commands, according to your system:
248
+
249
+ ```shell
250
+ # Base ctransformers with no GPU acceleration
251
+ pip install llama-cpp-python
252
+ # With NVidia CUDA acceleration
253
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
254
+ # Or with OpenBLAS acceleration
255
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
256
+ # Or with CLBLast acceleration
257
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
258
+ # Or with AMD ROCm GPU acceleration (Linux only)
259
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
260
+ # Or with Metal GPU acceleration for macOS systems only
261
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
262
+
263
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
264
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
265
+ pip install llama-cpp-python
266
+ ```
267
+
268
+ #### Simple llama-cpp-python example code
269
+
270
+ ```python
271
+ from llama_cpp import Llama
272
+
273
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
274
+ llm = Llama(
275
+ model_path="./phi-2-dpo.Q4_K_M.gguf", # Download the model file first
276
+ n_ctx=2048, # The max sequence length to use - note that longer sequence lengths require much more resources
277
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
278
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
279
+ )
280
+
281
+ # Simple inference example
282
+ output = llm(
283
+ "### Human: {prompt}\n\n### Assistant:", # Prompt
284
+ max_tokens=512, # Generate up to 512 tokens
285
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
286
+ echo=True # Whether to echo the prompt
287
+ )
288
+
289
+ # Chat Completion API
290
+
291
+ llm = Llama(model_path="./phi-2-dpo.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
292
+ llm.create_chat_completion(
293
+ messages = [
294
+ {"role": "system", "content": "You are a story writing assistant."},
295
+ {
296
+ "role": "user",
297
+ "content": "Write a story about llamas."
298
+ }
299
+ ]
300
+ )
301
+ ```
302
+
303
+ ## How to use with LangChain
304
+
305
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
306
+
307
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
308
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
309
+
310
+ <!-- README_GGUF.md-how-to-run end -->
311
+
312
+ <!-- footer start -->
313
+ <!-- 200823 -->
314
+ ## Discord
315
+
316
+ For further support, and discussions on these models and AI in general, join us at:
317
+
318
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
319
+
320
+ ## Thanks, and how to contribute
321
+
322
+ Thanks to the [chirper.ai](https://chirper.ai) team!
323
+
324
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
325
+
326
+ I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.
327
+
328
+ If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.
329
+
330
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
331
+
332
+ * Patreon: https://patreon.com/TheBlokeAI
333
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
334
+
335
+ **Special thanks to**: Aemon Algiz.
336
+
337
+ **Patreon special mentions**: Michael Levine, 阿明, Trailburnt, Nikolai Manek, John Detwiler, Randy H, Will Dee, Sebastain Graf, NimbleBox.ai, Eugene Pentland, Emad Mostaque, Ai Maven, Jim Angel, Jeff Scroggin, Michael Davis, Manuel Alberto Morcote, Stephen Murray, Robert, Justin Joy, Luke @flexchar, Brandon Frisco, Elijah Stavena, S_X, Dan Guido, Undi ., Komninos Chatzipapas, Shadi, theTransient, Lone Striker, Raven Klaugh, jjj, Cap'n Zoog, Michel-Marie MAUDET (LINAGORA), Matthew Berman, David, Fen Risland, Omer Bin Jawed, Luke Pendergrass, Kalila, OG, Erik Bjäreholt, Rooh Singh, Joseph William Delisle, Dan Lewis, TL, John Villwock, AzureBlack, Brad, Pedro Madruga, Caitlyn Gatomon, K, jinyuan sun, Mano Prime, Alex, Jeffrey Morgan, Alicia Loh, Illia Dulskyi, Chadd, transmissions 11, fincy, Rainer Wilmers, ReadyPlayerEmma, knownsqashed, Mandus, biorpg, Deo Leter, Brandon Phillips, SuperWojo, Sean Connelly, Iucharbius, Jack West, Harry Royden McLaughlin, Nicholas, terasurfer, Vitor Caleffi, Duane Dunston, Johann-Peter Hartmann, David Ziegler, Olakabola, Ken Nordquist, Trenton Dambrowitz, Tom X Nguyen, Vadim, Ajan Kanaga, Leonard Tan, Clay Pascal, Alexandros Triantafyllidis, JM33133, Xule, vamX, ya boyyy, subjectnull, Talal Aujan, Alps Aficionado, wassieverse, Ari Malik, James Bentley, Woland, Spencer Kim, Michael Dempsey, Fred von Graf, Elle, zynix, William Richards, Stanislav Ovsiannikov, Edmond Seymore, Jonathan Leane, Martin Kemka, usrbinkat, Enrico Ros
338
+
339
+
340
+ Thank you to all my generous patrons and donaters!
341
+
342
+ And thank you again to a16z for their generous grant.
343
+
344
+ <!-- footer end -->
345
+
346
+ <!-- original-model-card start -->
347
+ # Original model card: Xuechen Li's Phi 2 DPO
348
+
349
+
350
+ ## Model Summary
351
+
352
+ `phi-2-dpo` is an instruction-tuned model from an earlier SFT model [`phi-2-sft`](https://huggingface.co/lxuechen/phi-2-sft). Direct preference optimization (DPO) is used for fine-tuning on a 10k subset of the [UltraFeedback dataset](https://huggingface.co/datasets/HuggingFaceH4/ultrafeedback_binarized).
353
+
354
+ The purpose of the experiment is to understand the quality of the pre-trained Phi-2 model. The good news is that `phi-2-dpo` can follow open-ended user instructions well.
355
+
356
+ ## Decoding
357
+
358
+ Format your prompt as
359
+ ```
360
+ """### Human: {instruction}
361
+
362
+ ### Assistant:"""
363
+ ```
364
+ where `instruction` is your query.
365
+
366
+
367
+ Here's a full-fledged example:
368
+
369
+ ```
370
+ import torch
371
+ import transformers
372
+
373
+ model: transformers.PreTrainedModel = transformers.AutoModelForCausalLM.from_pretrained(
374
+ "lxuechen/phi-2-dpo",
375
+ low_cpu_mem_usage=True,
376
+ device_map="auto",
377
+ trust_remote_code=True,
378
+ torch_dtype=torch.float16
379
+ )
380
+ tokenizer = transformers.AutoTokenizer.from_pretrained(model_name_or_path)
381
+
382
+ input_text = "### Human: Give me a good recipe for a chinese dish\n\n### Assistant:"
383
+
384
+ outputs = model.generate(
385
+ tokenizer(input_text, return_tensors="pt").to(model.device)['input_ids'],
386
+ max_length=1024,
387
+ temperature=0.7,
388
+ top_p=0.9,
389
+ do_sample=True,
390
+ pad_token_id=tokenizer.pad_token_id,
391
+ eos_token_id=tokenizer.eos_token_id,
392
+ max_new_tokens=1024
393
+ )
394
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
395
+ ```
396
+
397
+ ## Training
398
+
399
+ The model was fine-tuned on a 10k subset of the binarized version of UltraFeedback with DPO.
400
+
401
+ Hyperparameters:
402
+ - learning rate: 3% linear warmup, with a peak of 3e-5 and cosine decay
403
+ - epochs: 2
404
+ - batch size: 64
405
+ - context length: 1024
406
+ - DPO beta: 0.1
407
+
408
+ ## Limitations of `phi-2-dpo`
409
+
410
+ * Generate Inaccurate Code and Facts: The model may produce incorrect code snippets and statements. Users should treat these outputs as suggestions or starting points, not as definitive or accurate solutions.
411
+
412
+ * Limited Scope for code: Majority of Phi-2 training data is based in Python and use common packages such as "typing, math, random, collections, datetime, itertools". If the model generates Python scripts that utilize other packages or scripts in other languages, we strongly recommend users manually verify all API uses.
413
+
414
+ * Unreliable Responses to Instruction: The model has not undergone instruction fine-tuning. As a result, it may struggle or fail to adhere to intricate or nuanced instructions provided by users.
415
+
416
+ * Language Limitations: The model is primarily designed to understand standard English. Informal English, slang, or any other languages might pose challenges to its comprehension, leading to potential misinterpretations or errors in response.
417
+
418
+ * Potential Societal Biases: Phi-2 is not entirely free from societal biases despite efforts in assuring trainig data safety. There's a possibility it may generate content that mirrors these societal biases, particularly if prompted or instructed to do so. We urge users to be aware of this and to exercise caution and critical thinking when interpreting model outputs.
419
+
420
+ * Toxicity: Despite being trained with carefully selected data, the model can still produce harmful content if explicitly prompted or instructed to do so. We chose to release the model for research purposes only -- We hope to help the open-source community develop the most effective ways to reduce the toxicity of a model directly after pretraining.
421
+
422
+ * Verbosity: Phi-2 being a base model often produces irrelevant or extra text and responses following its first answer to user prompts within a single turn. This is due to its training dataset being primarily textbooks, which results in textbook-like responses.
423
+
424
+ <!-- original-model-card end -->