TheBloke commited on
Commit
a81534c
1 Parent(s): 8c1679b

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +537 -0
README.md ADDED
@@ -0,0 +1,537 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: microsoft/Orca-2-13b
3
+ inference: false
4
+ license: other
5
+ model_creator: Microsoft
6
+ model_name: Orca 2 13B
7
+ model_type: llama
8
+ pipeline_tag: text-generation
9
+ prompt_template: '<|im_start|>system
10
+
11
+ {system_message}<|im_end|>
12
+
13
+ <|im_start|>user
14
+
15
+ {prompt}<|im_end|>
16
+
17
+ <|im_start|>assistant
18
+
19
+ '
20
+ quantized_by: TheBloke
21
+ tags:
22
+ - orca
23
+ - orca2
24
+ - microsoft
25
+ ---
26
+ <!-- markdownlint-disable MD041 -->
27
+
28
+ <!-- header start -->
29
+ <!-- 200823 -->
30
+ <div style="width: auto; margin-left: auto; margin-right: auto">
31
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
32
+ </div>
33
+ <div style="display: flex; justify-content: space-between; width: 100%;">
34
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
35
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
36
+ </div>
37
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
38
+ <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>
39
+ </div>
40
+ </div>
41
+ <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>
42
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
43
+ <!-- header end -->
44
+
45
+ # Orca 2 13B - GGUF
46
+ - Model creator: [Microsoft](https://huggingface.co/microsoft)
47
+ - Original model: [Orca 2 13B](https://huggingface.co/microsoft/Orca-2-13b)
48
+
49
+ <!-- description start -->
50
+ ## Description
51
+
52
+ This repo contains GGUF format model files for [Microsoft's Orca 2 13B](https://huggingface.co/microsoft/Orca-2-13b).
53
+
54
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
55
+
56
+ <!-- description end -->
57
+ <!-- README_GGUF.md-about-gguf start -->
58
+ ### About GGUF
59
+
60
+ 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.
61
+
62
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
63
+
64
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
65
+ * [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.
66
+ * [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.
67
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
68
+ * [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.
69
+ * [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.
70
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
71
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
72
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
73
+
74
+ <!-- README_GGUF.md-about-gguf end -->
75
+ <!-- repositories-available start -->
76
+ ## Repositories available
77
+
78
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Orca-2-13B-AWQ)
79
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Orca-2-13B-GPTQ)
80
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Orca-2-13B-GGUF)
81
+ * [Microsoft's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/microsoft/Orca-2-13b)
82
+ <!-- repositories-available end -->
83
+
84
+ <!-- prompt-template start -->
85
+ ## Prompt template: ChatML
86
+
87
+ ```
88
+ <|im_start|>system
89
+ {system_message}<|im_end|>
90
+ <|im_start|>user
91
+ {prompt}<|im_end|>
92
+ <|im_start|>assistant
93
+
94
+ ```
95
+
96
+ <!-- prompt-template end -->
97
+
98
+
99
+ <!-- compatibility_gguf start -->
100
+ ## Compatibility
101
+
102
+ 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)
103
+
104
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
105
+
106
+ ## Explanation of quantisation methods
107
+
108
+ <details>
109
+ <summary>Click to see details</summary>
110
+
111
+ The new methods available are:
112
+
113
+ * 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)
114
+ * 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.
115
+ * 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.
116
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
117
+ * 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
118
+
119
+ Refer to the Provided Files table below to see what files use which methods, and how.
120
+ </details>
121
+ <!-- compatibility_gguf end -->
122
+
123
+ <!-- README_GGUF.md-provided-files start -->
124
+ ## Provided files
125
+
126
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
127
+ | ---- | ---- | ---- | ---- | ---- | ----- |
128
+ | [orca-2-13b.Q2_K.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q2_K.gguf) | Q2_K | 2 | 5.43 GB| 7.93 GB | smallest, significant quality loss - not recommended for most purposes |
129
+ | [orca-2-13b.Q3_K_S.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q3_K_S.gguf) | Q3_K_S | 3 | 5.66 GB| 8.16 GB | very small, high quality loss |
130
+ | [orca-2-13b.Q3_K_M.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q3_K_M.gguf) | Q3_K_M | 3 | 6.34 GB| 8.84 GB | very small, high quality loss |
131
+ | [orca-2-13b.Q3_K_L.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q3_K_L.gguf) | Q3_K_L | 3 | 6.93 GB| 9.43 GB | small, substantial quality loss |
132
+ | [orca-2-13b.Q4_0.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q4_0.gguf) | Q4_0 | 4 | 7.37 GB| 9.87 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
133
+ | [orca-2-13b.Q4_K_S.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q4_K_S.gguf) | Q4_K_S | 4 | 7.41 GB| 9.91 GB | small, greater quality loss |
134
+ | [orca-2-13b.Q4_K_M.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q4_K_M.gguf) | Q4_K_M | 4 | 7.87 GB| 10.37 GB | medium, balanced quality - recommended |
135
+ | [orca-2-13b.Q5_0.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q5_0.gguf) | Q5_0 | 5 | 8.97 GB| 11.47 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
136
+ | [orca-2-13b.Q5_K_S.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q5_K_S.gguf) | Q5_K_S | 5 | 8.97 GB| 11.47 GB | large, low quality loss - recommended |
137
+ | [orca-2-13b.Q5_K_M.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q5_K_M.gguf) | Q5_K_M | 5 | 9.23 GB| 11.73 GB | large, very low quality loss - recommended |
138
+ | [orca-2-13b.Q6_K.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q6_K.gguf) | Q6_K | 6 | 10.68 GB| 13.18 GB | very large, extremely low quality loss |
139
+ | [orca-2-13b.Q8_0.gguf](https://huggingface.co/TheBloke/Orca-2-13B-GGUF/blob/main/orca-2-13b.Q8_0.gguf) | Q8_0 | 8 | 13.83 GB| 16.33 GB | very large, extremely low quality loss - not recommended |
140
+
141
+ **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.
142
+
143
+
144
+
145
+ <!-- README_GGUF.md-provided-files end -->
146
+
147
+ <!-- README_GGUF.md-how-to-download start -->
148
+ ## How to download GGUF files
149
+
150
+ **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.
151
+
152
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
153
+
154
+ * LM Studio
155
+ * LoLLMS Web UI
156
+ * Faraday.dev
157
+
158
+ ### In `text-generation-webui`
159
+
160
+ Under Download Model, you can enter the model repo: TheBloke/Orca-2-13B-GGUF and below it, a specific filename to download, such as: orca-2-13b.Q4_K_M.gguf.
161
+
162
+ Then click Download.
163
+
164
+ ### On the command line, including multiple files at once
165
+
166
+ I recommend using the `huggingface-hub` Python library:
167
+
168
+ ```shell
169
+ pip3 install huggingface-hub
170
+ ```
171
+
172
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
173
+
174
+ ```shell
175
+ huggingface-cli download TheBloke/Orca-2-13B-GGUF orca-2-13b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
176
+ ```
177
+
178
+ <details>
179
+ <summary>More advanced huggingface-cli download usage</summary>
180
+
181
+ You can also download multiple files at once with a pattern:
182
+
183
+ ```shell
184
+ huggingface-cli download TheBloke/Orca-2-13B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
185
+ ```
186
+
187
+ 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).
188
+
189
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
190
+
191
+ ```shell
192
+ pip3 install hf_transfer
193
+ ```
194
+
195
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
196
+
197
+ ```shell
198
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Orca-2-13B-GGUF orca-2-13b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
199
+ ```
200
+
201
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
202
+ </details>
203
+ <!-- README_GGUF.md-how-to-download end -->
204
+
205
+ <!-- README_GGUF.md-how-to-run start -->
206
+ ## Example `llama.cpp` command
207
+
208
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
209
+
210
+ ```shell
211
+ ./main -ngl 32 -m orca-2-13b.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant"
212
+ ```
213
+
214
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
215
+
216
+ Change `-c 4096` 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.
217
+
218
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
219
+
220
+ 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)
221
+
222
+ ## How to run in `text-generation-webui`
223
+
224
+ 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).
225
+
226
+ ## How to run from Python code
227
+
228
+ 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.
229
+
230
+ ### How to load this model in Python code, using ctransformers
231
+
232
+ #### First install the package
233
+
234
+ Run one of the following commands, according to your system:
235
+
236
+ ```shell
237
+ # Base ctransformers with no GPU acceleration
238
+ pip install ctransformers
239
+ # Or with CUDA GPU acceleration
240
+ pip install ctransformers[cuda]
241
+ # Or with AMD ROCm GPU acceleration (Linux only)
242
+ CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
243
+ # Or with Metal GPU acceleration for macOS systems only
244
+ CT_METAL=1 pip install ctransformers --no-binary ctransformers
245
+ ```
246
+
247
+ #### Simple ctransformers example code
248
+
249
+ ```python
250
+ from ctransformers import AutoModelForCausalLM
251
+
252
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
253
+ llm = AutoModelForCausalLM.from_pretrained("TheBloke/Orca-2-13B-GGUF", model_file="orca-2-13b.Q4_K_M.gguf", model_type="llama", gpu_layers=50)
254
+
255
+ print(llm("AI is going to"))
256
+ ```
257
+
258
+ ## How to use with LangChain
259
+
260
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
261
+
262
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
263
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
264
+
265
+ <!-- README_GGUF.md-how-to-run end -->
266
+
267
+ <!-- footer start -->
268
+ <!-- 200823 -->
269
+ ## Discord
270
+
271
+ For further support, and discussions on these models and AI in general, join us at:
272
+
273
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
274
+
275
+ ## Thanks, and how to contribute
276
+
277
+ Thanks to the [chirper.ai](https://chirper.ai) team!
278
+
279
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
280
+
281
+ 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.
282
+
283
+ 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.
284
+
285
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
286
+
287
+ * Patreon: https://patreon.com/TheBlokeAI
288
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
289
+
290
+ **Special thanks to**: Aemon Algiz.
291
+
292
+ **Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
293
+
294
+
295
+ Thank you to all my generous patrons and donaters!
296
+
297
+ And thank you again to a16z for their generous grant.
298
+
299
+ <!-- footer end -->
300
+
301
+ <!-- original-model-card start -->
302
+ # Original model card: Microsoft's Orca 2 13B
303
+
304
+
305
+ # Orca 2
306
+
307
+ <!-- Provide a quick summary of what the model is/does. -->
308
+
309
+ Orca 2 is a helpful assistant that is built for research purposes only and provides a single turn response
310
+ in tasks such as reasoning over user given data, reading comprehension, math problem solving and text summarization.
311
+ The model is designed to excel particularly in reasoning.
312
+
313
+ We open-source Orca 2 to encourage further research on the development, evaluation, and alignment of smaller LMs.
314
+
315
+ ## What is Orca 2’s intended use(s)?
316
+
317
+ + Orca 2 is built for research purposes only.
318
+ + The main purpose is to allow the research community to assess its abilities and to provide a foundation for
319
+ building better frontier models.
320
+
321
+ ## How was Orca 2 evaluated?
322
+
323
+ + Orca 2 has been evaluated on a large number of tasks ranging from reasoning to grounding and safety. Please refer
324
+ to Section 6 and Appendix in the [Orca 2 paper](https://arxiv.org/pdf/2311.11045.pdf) for details on evaluations.
325
+
326
+ ## Model Details
327
+
328
+ Orca 2 is a finetuned version of LLAMA-2. Orca 2’s training data is a synthetic dataset that was created to enhance the small model’s reasoning abilities.
329
+ All synthetic training data was moderated using the Microsoft Azure content filters. More details about the model can be found in the [Orca 2 paper](https://arxiv.org/pdf/2311.11045.pdf).
330
+
331
+ Please refer to LLaMA-2 technical report for details on the model architecture.
332
+
333
+ ## License
334
+
335
+ Orca 2 is licensed under the [Microsoft Research License](LICENSE).
336
+
337
+ Llama 2 is licensed under the [LLAMA 2 Community License](https://ai.meta.com/llama/license/), Copyright © Meta Platforms, Inc. All Rights Reserved.
338
+
339
+ ## Bias, Risks, and Limitations
340
+
341
+ Orca 2, built upon the LLaMA 2 model family, retains many of its limitations, as well as the
342
+ common limitations of other large language models or limitation caused by its training process,
343
+ including:
344
+
345
+ **Data Biases**: Large language models, trained on extensive data, can inadvertently carry
346
+ biases present in the source data. Consequently, the models may generate outputs that could
347
+ be potentially biased or unfair.
348
+
349
+ **Lack of Contextual Understanding**: Despite their impressive capabilities in language understanding and generation, these models exhibit limited real-world understanding, resulting
350
+ in potential inaccuracies or nonsensical responses.
351
+
352
+ **Lack of Transparency**: Due to the complexity and size, large language models can act
353
+ as “black boxes”, making it difficult to comprehend the rationale behind specific outputs or
354
+ decisions. We recommend reviewing transparency notes from Azure for more information.
355
+
356
+ **Content Harms**: There are various types of content harms that large language models
357
+ can cause. It is important to be aware of them when using these models, and to take
358
+ actions to prevent them. It is recommended to leverage various content moderation services
359
+ provided by different companies and institutions. On an important note, we hope for better
360
+ regulations and standards from government and technology leaders around content harms
361
+ for AI technologies in future. We value and acknowledge the important role that research
362
+ and open source community can play in this direction.
363
+
364
+ **Hallucination**: It is important to be aware and cautious not to entirely rely on a given
365
+ language model for critical decisions or information that might have deep impact as it is
366
+ not obvious how to prevent these models from fabricating content. Moreover, it is not clear
367
+ whether small models may be more susceptible to hallucination in ungrounded generation
368
+ use cases due to their smaller sizes and hence reduced memorization capacities. This is an
369
+ active research topic and we hope there will be more rigorous measurement, understanding
370
+ and mitigations around this topic.
371
+
372
+ **Potential for Misuse**: Without suitable safeguards, there is a risk that these models could
373
+ be maliciously used for generating disinformation or harmful content.
374
+
375
+ **Data Distribution**: Orca 2’s performance is likely to correlate strongly with the distribution
376
+ of the tuning data. This correlation might limit its accuracy in areas underrepresented in
377
+ the training dataset such as math, coding, and reasoning.
378
+
379
+ **System messages**: Orca 2 demonstrates variance in performance depending on the system
380
+ instructions. Additionally, the stochasticity introduced by the model size may lead to
381
+ generation of non-deterministic responses to different system instructions.
382
+
383
+ **Zero-Shot Settings**: Orca 2 was trained on data that mostly simulate zero-shot settings.
384
+ While the model demonstrate very strong performance in zero-shot settings, it does not show
385
+ the same gains of using few-shot learning compared to other, specially larger, models.
386
+
387
+ **Synthetic data**: As Orca 2 is trained on synthetic data, it could inherit both the advantages
388
+ and shortcomings of the models and methods used for data generation. We posit that Orca
389
+ 2 benefits from the safety measures incorporated during training and safety guardrails (e.g.,
390
+ content filter) within the Azure OpenAI API. However, detailed studies are required for
391
+ better quantification of such risks.
392
+
393
+ This model is solely designed for research settings, and its testing has only been carried
394
+ out in such environments. It should not be used in downstream applications, as additional
395
+ analysis is needed to assess potential harm or bias in the proposed application.
396
+
397
+ ## Getting started with Orca 2
398
+
399
+ **Inference with Hugging Face library**
400
+
401
+ ```python
402
+ import torch
403
+ import transformers
404
+
405
+ if torch.cuda.is_available():
406
+ torch.set_default_device("cuda")
407
+ else:
408
+ torch.set_default_device("cpu")
409
+
410
+ model = transformers.AutoModelForCausalLM.from_pretrained("microsoft/Orca-2-13b", device_map='auto')
411
+
412
+ # https://github.com/huggingface/transformers/issues/27132
413
+ # please use the slow tokenizer since fast and slow tokenizer produces different tokens
414
+ tokenizer = transformers.AutoTokenizer.from_pretrained(
415
+ "microsoft/Orca-2-13b",
416
+ use_fast=False,
417
+ )
418
+
419
+ system_message = "You are Orca, an AI language model created by Microsoft. You are a cautious assistant. You carefully follow instructions. You are helpful and harmless and you follow ethical guidelines and promote positive behavior."
420
+ user_message = "How can you determine if a restaurant is popular among locals or mainly attracts tourists, and why might this information be useful?"
421
+
422
+ prompt = f"<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{user_message}<|im_end|>\n<|im_start|>assistant"
423
+
424
+ inputs = tokenizer(prompt, return_tensors='pt')
425
+ output_ids = model.generate(inputs["input_ids"],)
426
+ answer = tokenizer.batch_decode(output_ids)[0]
427
+
428
+ print(answer)
429
+
430
+ # This example continues showing how to add a second turn message by the user to the conversation
431
+ second_turn_user_message = "Give me a list of the key points of your first answer."
432
+
433
+ # we set add_special_tokens=False because we dont want to automatically add a bos_token between messages
434
+ second_turn_message_in_markup = f"\n<|im_start|>user\n{second_turn_user_message}<|im_end|>\n<|im_start|>assistant"
435
+ second_turn_tokens = tokenizer(second_turn_message_in_markup, return_tensors='pt', add_special_tokens=False)
436
+ second_turn_input = torch.cat([output_ids, second_turn_tokens['input_ids']], dim=1)
437
+
438
+ output_ids_2 = model.generate(second_turn_input,)
439
+ second_turn_answer = tokenizer.batch_decode(output_ids_2)[0]
440
+
441
+ print(second_turn_answer)
442
+ ```
443
+
444
+
445
+ **Safe inference with Azure AI Content Safety**
446
+
447
+ The usage of [Azure AI Content Safety](https://azure.microsoft.com/en-us/products/ai-services/ai-content-safety/) on top of model prediction is strongly encouraged
448
+ and can help prevent content harms. Azure AI Content Safety is a content moderation platform
449
+ that uses AI to keep your content safe. By integrating Orca 2 with Azure AI Content Safety,
450
+ we can moderate the model output by scanning it for sexual content, violence, hate, and
451
+ self-harm with multiple severity levels and multi-lingual detection.
452
+
453
+ ```python
454
+ import os
455
+ import math
456
+ import transformers
457
+ import torch
458
+
459
+ from azure.ai.contentsafety import ContentSafetyClient
460
+ from azure.core.credentials import AzureKeyCredential
461
+ from azure.core.exceptions import HttpResponseError
462
+ from azure.ai.contentsafety.models import AnalyzeTextOptions
463
+
464
+ CONTENT_SAFETY_KEY = os.environ["CONTENT_SAFETY_KEY"]
465
+ CONTENT_SAFETY_ENDPOINT = os.environ["CONTENT_SAFETY_ENDPOINT"]
466
+
467
+ # We use Azure AI Content Safety to filter out any content that reaches "Medium" threshold
468
+ # For more information: https://learn.microsoft.com/en-us/azure/ai-services/content-safety/
469
+ def should_filter_out(input_text, threshold=4):
470
+ # Create an Content Safety client
471
+ client = ContentSafetyClient(CONTENT_SAFETY_ENDPOINT, AzureKeyCredential(CONTENT_SAFETY_KEY))
472
+
473
+ # Construct a request
474
+ request = AnalyzeTextOptions(text=input_text)
475
+
476
+ # Analyze text
477
+ try:
478
+ response = client.analyze_text(request)
479
+ except HttpResponseError as e:
480
+ print("Analyze text failed.")
481
+ if e.error:
482
+ print(f"Error code: {e.error.code}")
483
+ print(f"Error message: {e.error.message}")
484
+ raise
485
+ print(e)
486
+ raise
487
+
488
+ categories = ["hate_result", "self_harm_result", "sexual_result", "violence_result"]
489
+ max_score = -math.inf
490
+ for category in categories:
491
+ max_score = max(max_score, getattr(response, category).severity)
492
+
493
+ return max_score >= threshold
494
+
495
+ model_path = 'microsoft/Orca-2-13b'
496
+ device = torch.device("cuda:0" if torch.cuda.is_available() else "cpu")
497
+ model = transformers.AutoModelForCausalLM.from_pretrained(model_path)
498
+ model.to(device)
499
+
500
+ tokenizer = transformers.AutoTokenizer.from_pretrained(
501
+ model_path,
502
+ model_max_length=4096,
503
+ padding_side="right",
504
+ use_fast=False,
505
+ add_special_tokens=False,
506
+ )
507
+
508
+ system_message = "You are Orca, an AI language model created by Microsoft. You are a cautious assistant. You carefully follow instructions. You are helpful and harmless and you follow ethical guidelines and promote positive behavior."
509
+ user_message = "\" \n :You can't just say, \"\"that's crap\"\" and remove it without gaining a consensus. You already know this, based on your block history. —/ \" \nIs the comment obscene? \nOptions : Yes, No."
510
+
511
+ prompt = f"<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{user_message}<|im_end|>\n<|im_start|>assistant"
512
+
513
+ inputs = tokenizer(prompt, return_tensors='pt')
514
+ inputs = inputs.to(device)
515
+
516
+ output_ids = model.generate(inputs["input_ids"], max_length=4096, do_sample=False, temperature=0.0, use_cache=True)
517
+ sequence_length = inputs["input_ids"].shape[1]
518
+ new_output_ids = output_ids[:, sequence_length:]
519
+ answers = tokenizer.batch_decode(new_output_ids, skip_special_tokens=True)
520
+ final_output = answers[0] if not should_filter_out(answers[0]) else "[Content Filtered]"
521
+
522
+ print(final_output)
523
+ ```
524
+
525
+ ## Citation
526
+ ```bibtex
527
+ @misc{mitra2023orca,
528
+ title={Orca 2: Teaching Small Language Models How to Reason},
529
+ author={Arindam Mitra and Luciano Del Corro and Shweti Mahajan and Andres Codas and Clarisse Simoes and Sahaj Agrawal and Xuxi Chen and Anastasia Razdaibiedina and Erik Jones and Kriti Aggarwal and Hamid Palangi and Guoqing Zheng and Corby Rosset and Hamed Khanpour and Ahmed Awadallah},
530
+ year={2023},
531
+ eprint={2311.11045},
532
+ archivePrefix={arXiv},
533
+ primaryClass={cs.AI}
534
+ }
535
+ ```
536
+
537
+ <!-- original-model-card end -->