TheBloke commited on
Commit
27c23ef
1 Parent(s): 402eeba

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +379 -0
README.md ADDED
@@ -0,0 +1,379 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ language:
4
+ - en
5
+ - pl
6
+ license: llama2
7
+ model_creator: Voicelab
8
+ model_link: https://huggingface.co/Voicelab/trurl-2-7b
9
+ model_name: Trurl 2 7B
10
+ model_type: llama
11
+ pipeline_tag: text-generation
12
+ quantized_by: TheBloke
13
+ tags:
14
+ - voicelab
15
+ - pytorch
16
+ - llama-2
17
+ - trurl
18
+ - trurl-2
19
+ ---
20
+
21
+ <!-- header start -->
22
+ <!-- 200823 -->
23
+ <div style="width: auto; margin-left: auto; margin-right: auto">
24
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
25
+ </div>
26
+ <div style="display: flex; justify-content: space-between; width: 100%;">
27
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
28
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
29
+ </div>
30
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
31
+ <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>
32
+ </div>
33
+ </div>
34
+ <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>
35
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
36
+ <!-- header end -->
37
+
38
+ # Trurl 2 7B - GGUF
39
+ - Model creator: [Voicelab](https://huggingface.co/Voicelab)
40
+ - Original model: [Trurl 2 7B](https://huggingface.co/Voicelab/trurl-2-7b)
41
+
42
+ ## Description
43
+
44
+ This repo contains GGUF format model files for [Voicelab's Trurl 2 7B](https://huggingface.co/Voicelab/trurl-2-7b).
45
+
46
+ <!-- README_GGUF.md-about-gguf start -->
47
+ ### About GGUF
48
+
49
+ 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.
50
+
51
+ The key benefit of GGUF is that it is a extensible, future-proof format which stores more information about the model as metadata. It also includes significantly improved tokenization code, including for the first time full support for special tokens. This should improve performance, especially with models that use new special tokens and implement custom prompt templates.
52
+
53
+ Here are a list of clients and libraries that are known to support GGUF:
54
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp).
55
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI. Supports GGUF with GPU acceleration via the ctransformers backend - llama-cpp-python backend should work soon too.
56
+ * [KoboldCpp](https://github.com/LostRuins/koboldcpp), now supports GGUF as of release 1.41! A powerful GGML web UI, with full GPU accel. Especially good for story telling.
57
+ * [LM Studio](https://lmstudio.ai/), version 0.2.2 and later support GGUF. A fully featured local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
58
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), should now work, choose the `c_transformers` backend. A great web UI with many interesting features. Supports CUDA GPU acceleration.
59
+ * [ctransformers](https://github.com/marella/ctransformers), now supports GGUF as of version 0.2.24! A Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
60
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), supports GGUF as of version 0.1.79. A Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
61
+ * [candle](https://github.com/huggingface/candle), added GGUF support on August 22nd. Candle is a Rust ML framework with a focus on performance, including GPU support, and ease of use.
62
+
63
+ <!-- README_GGUF.md-about-gguf end -->
64
+ <!-- repositories-available start -->
65
+ ## Repositories available
66
+
67
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Trurl-2-7B-GPTQ)
68
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF)
69
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/Trurl-2-7B-GGML)
70
+ * [Voicelab's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Voicelab/trurl-2-7b)
71
+ <!-- repositories-available end -->
72
+
73
+ <!-- prompt-template start -->
74
+ ## Prompt template: Llama-2-Chat
75
+
76
+ ```
77
+ [INST] <<SYS>>
78
+ You are a helpful, respectful and honest assistant. Always answer as helpfully as possible, while being safe. Your answers should not include any harmful, unethical, racist, sexist, toxic, dangerous, or illegal content. Please ensure that your responses are socially unbiased and positive in nature. If a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information.
79
+ <</SYS>>
80
+ {prompt}[/INST]
81
+
82
+ ```
83
+
84
+ <!-- prompt-template end -->
85
+ <!-- compatibility_gguf start -->
86
+ ## Compatibility
87
+
88
+ These quantised GGUF files are compatible with llama.cpp from August 21st 2023 onwards, as of commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9)
89
+
90
+ They are now also compatible with many third party UIs and libraries - please see the list at the top of the README.
91
+
92
+ ## Explanation of quantisation methods
93
+ <details>
94
+ <summary>Click to see details</summary>
95
+
96
+ The new methods available are:
97
+ * 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)
98
+ * 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.
99
+ * 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.
100
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
101
+ * 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
102
+
103
+ Refer to the Provided Files table below to see what files use which methods, and how.
104
+ </details>
105
+ <!-- compatibility_gguf end -->
106
+
107
+ <!-- README_GGUF.md-provided-files start -->
108
+ ## Provided files
109
+
110
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
111
+ | ---- | ---- | ---- | ---- | ---- | ----- |
112
+ | [trurl-2-7b.Q2_K.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q2_K.gguf) | Q2_K | 2 | 2.83 GB| 5.33 GB | smallest, significant quality loss - not recommended for most purposes |
113
+ | [trurl-2-7b.Q3_K_S.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q3_K_S.gguf) | Q3_K_S | 3 | 2.95 GB| 5.45 GB | very small, high quality loss |
114
+ | [trurl-2-7b.Q3_K_M.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q3_K_M.gguf) | Q3_K_M | 3 | 3.30 GB| 5.80 GB | very small, high quality loss |
115
+ | [trurl-2-7b.Q3_K_L.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q3_K_L.gguf) | Q3_K_L | 3 | 3.60 GB| 6.10 GB | small, substantial quality loss |
116
+ | [trurl-2-7b.Q4_0.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q4_0.gguf) | Q4_0 | 4 | 3.83 GB| 6.33 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
117
+ | [trurl-2-7b.Q4_K_S.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q4_K_S.gguf) | Q4_K_S | 4 | 3.86 GB| 6.36 GB | small, greater quality loss |
118
+ | [trurl-2-7b.Q4_K_M.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q4_K_M.gguf) | Q4_K_M | 4 | 4.08 GB| 6.58 GB | medium, balanced quality - recommended |
119
+ | [trurl-2-7b.Q5_0.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q5_0.gguf) | Q5_0 | 5 | 4.65 GB| 7.15 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
120
+ | [trurl-2-7b.Q5_K_S.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q5_K_S.gguf) | Q5_K_S | 5 | 4.65 GB| 7.15 GB | large, low quality loss - recommended |
121
+ | [trurl-2-7b.Q5_K_M.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q5_K_M.gguf) | Q5_K_M | 5 | 4.78 GB| 7.28 GB | large, very low quality loss - recommended |
122
+ | [trurl-2-7b.Q6_K.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q6_K.gguf) | Q6_K | 6 | 5.53 GB| 8.03 GB | very large, extremely low quality loss |
123
+ | [trurl-2-7b.Q8_0.gguf](https://huggingface.co/TheBloke/Trurl-2-7B-GGUF/blob/main/trurl-2-7b.Q8_0.gguf) | Q8_0 | 8 | 7.16 GB| 9.66 GB | very large, extremely low quality loss - not recommended |
124
+
125
+ **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.
126
+
127
+
128
+
129
+ <!-- README_GGUF.md-provided-files end -->
130
+
131
+ <!-- README_GGUF.md-how-to-run start -->
132
+ ## Example `llama.cpp` command
133
+
134
+ Make sure you are using `llama.cpp` from commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9) or later.
135
+
136
+ For compatibility with older versions of llama.cpp, or for any third-party libraries or clients that haven't yet updated for GGUF, please use GGML files instead.
137
+
138
+ ```
139
+ ./main -t 10 -ngl 32 -m trurl-2-7b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "[INST] <<SYS>>\nYou are a helpful, respectful and honest assistant. Always answer as helpfully as possible, while being safe. Your answers should not include any harmful, unethical, racist, sexist, toxic, dangerous, or illegal content. Please ensure that your responses are socially unbiased and positive in nature. If a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information.\n<</SYS>>\nWrite a story about llamas[/INST]"
140
+ ```
141
+ Change `-t 10` to the number of physical CPU cores you have. For example if your system has 8 cores/16 threads, use `-t 8`. If offloading all layers to GPU, set `-t 1`.
142
+
143
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
144
+
145
+ Change `-c 4096` to the desired sequence length for this model. 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.
146
+
147
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
148
+
149
+ 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)
150
+
151
+ ## How to run in `text-generation-webui`
152
+
153
+ Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
154
+
155
+ ## How to run from Python code
156
+
157
+ 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.
158
+
159
+ ### How to load this model from Python using ctransformers
160
+
161
+ #### First install the package
162
+
163
+ ```bash
164
+ # Base ctransformers with no GPU acceleration
165
+ pip install ctransformers>=0.2.24
166
+ # Or with CUDA GPU acceleration
167
+ pip install ctransformers[cuda]>=0.2.24
168
+ # Or with ROCm GPU acceleration
169
+ CT_HIPBLAS=1 pip install ctransformers>=0.2.24 --no-binary ctransformers
170
+ # Or with Metal GPU acceleration for macOS systems
171
+ CT_METAL=1 pip install ctransformers>=0.2.24 --no-binary ctransformers
172
+ ```
173
+
174
+ #### Simple example code to load one of these GGUF models
175
+
176
+ ```python
177
+ from ctransformers import AutoModelForCausalLM
178
+
179
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
180
+ llm = AutoModelForCausalLM.from_pretrained("TheBloke/Trurl-2-7B-GGUF", model_file="trurl-2-7b.q4_K_M.gguf", model_type="llama", gpu_layers=50)
181
+
182
+ print(llm("AI is going to"))
183
+ ```
184
+
185
+ ## How to use with LangChain
186
+
187
+ Here's guides on using llama-cpp-python or ctransformers with LangChain:
188
+
189
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
190
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
191
+
192
+ <!-- README_GGUF.md-how-to-run end -->
193
+
194
+ <!-- footer start -->
195
+ <!-- 200823 -->
196
+ ## Discord
197
+
198
+ For further support, and discussions on these models and AI in general, join us at:
199
+
200
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
201
+
202
+ ## Thanks, and how to contribute.
203
+
204
+ Thanks to the [chirper.ai](https://chirper.ai) team!
205
+
206
+ 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.
207
+
208
+ 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.
209
+
210
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
211
+
212
+ * Patreon: https://patreon.com/TheBlokeAI
213
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
214
+
215
+ **Special thanks to**: Aemon Algiz.
216
+
217
+ **Patreon special mentions**: Russ Johnson, J, alfie_i, Alex, NimbleBox.ai, Chadd, Mandus, Nikolai Manek, Ken Nordquist, ya boyyy, Illia Dulskyi, Viktor Bowallius, vamX, Iucharbius, zynix, Magnesian, Clay Pascal, Pierre Kircher, Enrico Ros, Tony Hughes, Elle, Andrey, knownsqashed, Deep Realms, Jerry Meng, Lone Striker, Derek Yates, Pyrater, Mesiah Bishop, James Bentley, Femi Adebogun, Brandon Frisco, SuperWojo, Alps Aficionado, Michael Dempsey, Vitor Caleffi, Will Dee, Edmond Seymore, usrbinkat, LangChain4j, Kacper Wikieł, Luke Pendergrass, John Detwiler, theTransient, Nathan LeClaire, Tiffany J. Kim, biorpg, Eugene Pentland, Stanislav Ovsiannikov, Fred von Graf, terasurfer, Kalila, Dan Guido, Nitin Borwankar, 阿明, Ai Maven, John Villwock, Gabriel Puliatti, Stephen Murray, Asp the Wyvern, danny, Chris Smitley, ReadyPlayerEmma, S_X, Daniel P. Andersen, Olakabola, Jeffrey Morgan, Imad Khwaja, Caitlyn Gatomon, webtim, Alicia Loh, Trenton Dambrowitz, Swaroop Kallakuri, Erik Bjäreholt, Leonard Tan, Spiking Neurons AB, Luke @flexchar, Ajan Kanaga, Thomas Belote, Deo Leter, RoA, Willem Michiel, transmissions 11, subjectnull, Matthew Berman, Joseph William Delisle, David Ziegler, Michael Davis, Johann-Peter Hartmann, Talal Aujan, senxiiz, Artur Olbinski, Rainer Wilmers, Spencer Kim, Fen Risland, Cap'n Zoog, Rishabh Srivastava, Michael Levine, Geoffrey Montalvo, Sean Connelly, Alexandros Triantafyllidis, Pieter, Gabriel Tamborski, Sam, Subspace Studios, Junyu Yang, Pedro Madruga, Vadim, Cory Kujawski, K, Raven Klaugh, Randy H, Mano Prime, Sebastain Graf, Space Cruiser
218
+
219
+
220
+ Thank you to all my generous patrons and donaters!
221
+
222
+ And thank you again to a16z for their generous grant.
223
+
224
+ <!-- footer end -->
225
+
226
+ <!-- original-model-card start -->
227
+ # Original model card: Voicelab's Trurl 2 7B
228
+
229
+ <img src="https://public.3.basecamp.com/p/rs5XqmAuF1iEuW6U7nMHcZeY/upload/download/VL-NLP-short.png" alt="logo voicelab nlp" style="width:300px;"/>
230
+
231
+
232
+ # Trurl 2 -- Polish Llama 2
233
+
234
+ The new OPEN TRURL is a finetuned Llama 2, trained on over 1.7b tokens (970k conversational **Polish** and **English** samples) with a large context of 4096 tokens.
235
+ TRURL was trained on a large number of Polish data.
236
+ TRURL 2 is a collection of fine-tuned generative text models with 7 billion and 13 billion parameters.
237
+ This is the repository for the 7b fine-tuned model, optimized for dialogue use cases.
238
+
239
+
240
+ # Overview
241
+
242
+ **TRURL developers** Voicelab.AI
243
+
244
+ **Variations** Trurl 2 comes in 7B and 13B versions.
245
+
246
+ **Input** Models input text only.
247
+
248
+ **Output** Models generate text only.
249
+
250
+ **Model Architecture** Trurl is an auto-regressive language model that uses an optimized transformer architecture.
251
+
252
+ ||Training Data|Params|Content Length|Num. Samples|Num. Tokens|start LR|
253
+ |---|---|---|---|---|---|---|
254
+ |Trurl 2|*A new mix of private and publicly available online data*|7B|4k|970k|1.7b|2.0 x 10<sup>-5</sup>|
255
+ |Trurl 2|*A new mix of private and publicly available online data*|13B|4k|970k|1.7b|2.0 x 10<sup>-5</sup>|
256
+
257
+ ## Training data
258
+
259
+ The training data includes Q&A pairs from various sources including Alpaca comparison data with GPT, Falcon comparison data, Dolly 15k, Oasst1, Phu saferlfhf, ShareGPT version 2023.05.08v0 filtered and cleaned, Voicelab private datasets for JSON data extraction, modification, and analysis, CURLICAT dataset containing journal entries, dataset from Polish wiki with Q&A pairs grouped into conversations, Voicelab private dataset with sales conversations, arguments and objections, paraphrases, contact reason detection, and corrected dialogues.
260
+
261
+ ## Intended Use
262
+
263
+ Trurl 2 is intended for commercial and research use in Polish and English. Tuned models are intended for assistant-like chat, but also adapted for a variety of natural language generation tasks.
264
+
265
+ # Evaluation Results
266
+ |Model | Size| hellaswag | arc_challenge | MMLU|
267
+ |---|---|---|---|---|
268
+ | Llama-2-chat | 7B | 78.55% | 52.9% | 48.32% |
269
+ | Llama-2-chat | 13B | 81.94% | 59.04% | 54.64% |
270
+ | Trurl 2.0 (with MMLU) | 13B | 80.09% | 59.30% | 78.35% |
271
+ | Trurl 2.0 (no MMLU) | 13B | TO-DO | TO-DO | TO-DO|
272
+ | Trurl 2.0 (no MMLU) | 7b | 75.29% | 53.41%| 50.0%|
273
+
274
+
275
+ <img src="https://voicelab.ai/wp-content/uploads/trurl-hero.webp" alt="trurl graphic" style="width:100px;"/>
276
+
277
+ # Ethical Considerations and Limitations
278
+ Trurl 2, same as a Llama 2, is a new technology that carries risks with use. Testing conducted to date has been in Polish and English, and has not covered, nor could it cover all scenarios. For these reasons, as with all LLMs, Trurl 2’s potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses to user prompts. Therefore, before deploying any applications of Trurl 2, developers should perform safety testing and tuning tailored to their specific applications of the model.
279
+
280
+ Please see the Meta's Responsible Use Guide available at [https://ai.meta.com/llama/responsible-use-guide/](https://ai.meta.com/llama/responsible-use-guide)
281
+
282
+ # Example use
283
+ ## LLM
284
+ Simply pass a prompt to a model and decode an output. Model will continue writing text based on sample you provided.
285
+ ```
286
+ import torch
287
+ from transformers import LlamaForCausalLM, LlamaTokenizer
288
+
289
+ tokenizer = LlamaTokenizer.from_pretrained("Voicelab/trurl-2-7b")
290
+ model = LlamaForCausalLM.from_pretrained("Voicelab/trurl-2-7b")
291
+
292
+ prompt = "Yesterday, when I was"
293
+
294
+ tokenized_prompt = tokenizer(prompt, return_tensors="pt")
295
+
296
+ model.eval()
297
+ with torch.no_grad():
298
+ print(tokenizer.decode(
299
+ model.generate(**tokenized_prompt, max_new_tokens=200)[0],
300
+ skip_special_tokens=True))
301
+ ```
302
+ Generated output:
303
+ > Yesterday, when I was in the city, I saw a man who was walking his dog. and the dog was wearing a little sweater. I thought it was so cute! I wish I had a dog so I could get one of those sweaters for my own dog.
304
+
305
+ ## Chat
306
+ When using TRURL in a chat mode you should remember to use Llama 2 conversation template like in the example below.
307
+
308
+
309
+ ```
310
+ import torch
311
+ from transformers import LlamaForCausalLM, LlamaTokenizer
312
+
313
+ tokenizer = LlamaTokenizer.from_pretrained("Voicelab/trurl-2-7b")
314
+ model = LlamaForCausalLM.from_pretrained("Voicelab/trurl-2-7b")
315
+
316
+ prompt = """
317
+ <s>[INST] <<SYS>> You are a helpful, respectful and honest assistant. Always answer as helpfully as possible, while being safe.
318
+ Your answers should not include any harmful, unethical, racist, sexist, toxic, dangerous, or illegal content.
319
+ Please ensure that your responses are socially unbiased and positive in nature.\n\n
320
+ If a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct.
321
+ If you don't know the answer to a question, please don't share false information. <</SYS>>
322
+
323
+ What was the reason for calling in the conversation below? \n\n
324
+ AGENT: Hello, Bank of Albion, this is Mata Hari. How can I help you?
325
+ CLIENT: Hi. I've been locked out from my Internet account. I need your help.
326
+ AGENT: (yy) Yes, of course, I'll do my best to help you. But I need to find out why the locking-out happened. (yy) In order to ascertain that, I'll ask you a couple of questions to confirm your identity. I'm going to need your full name.
327
+ CLIENT: Lizz Truss.
328
+ AGENT: Thank you. Now I need your personal identification number.
329
+ CLIENT: Fourteen, two hundred thirty-one, thirty-eight, twenty-nine, sixty-five.
330
+ AGENT: Thank you. Now I need your client ID number. The client ID number is the eight digits we assigned to you at the very beginning, on conclusion of the contract.
331
+ CLIENT: OK. Give me a moment. I have to find it.
332
+ AGENT: (mhm) You'll find… You'll find it in the contract.
333
+ CLIENT: Yes, yes. I can see it. Sixty-five, twenty-nine, thirty-eight, thirty-one.
334
+ AGENT: Thank you. One final security question. Do you have any deposits in our bank?
335
+ CLIENT: No, no. I don't have any deposits in this bank.
336
+ AGENT: Thank you. Your identity has been (yy) confirmed. (yy) I can see that the account has been blocked, indeed, and you won't be able to log in via the Internet (yy) because (yy) the identity document which is listed for reference has expired. (yy) From what I can see, your identity document expired some time ago. Have you been issued a new one?
337
+ CLIENT: Well, no. I think my ID is still valid, you know. I didn't even know.
338
+ AGENT: Well, no... Your ID expired at the end of March. Well, almost at the end. Your old ID had been valid until 26 March. (yy) For that reason, your accout has been blocked, because you haven't notified us about the ID change for a few months. We are not interested if the ID document has been officialy reissued. (...) On our end, what matters is whether the document listed for our reference is valid (yy) so without a valid document I can't unlock your accout.
339
+ CLIENT: But I have to carry out an operation right now, so this is sort of problematic.
340
+ AGENT: I understand. But (yy) you are obligated, as an account holder, to notify the bank about any changes pending (yy), regrding, for example, your home address or phone number. Now, one of such safeguards protecting your… (yy) money, your sensitive data, is precisely about having a valid identification document. Since this is missing in your case, the account has been blocked. Now, I don't think this would have caught you off guard, because we always remind our customers that their ID is about to expire. When the ID is nearing expiration, we display relevant messages at least sixty days in advance. They appear once you've logged in, at the very top of the screen, there is a notification that (yy) the ID is about to expire (yy), so, well... The bank did notify you about this issue. Now, how you chose to act on this information was your choice, right? In any case, at this point, in order to unlock your accout, our protocols require that you produce a new identification document at one of our branches. You shall provide information concerning the new document number, new valid-thru date, and only then will you be able to use your account again. I can schedule an appointment with a consultant at our branch for you. What locality would you prefer?
341
+ CLIENT: Well, I'm not sure if I should share such information with you.
342
+ AGENT: And may I ask why exactly you are unsure? After all, you're calling a bank that runs your account, right?
343
+ CLIENT: Right, you know what, I need to go now. Good bye.
344
+ AGENT: (yy) Miss… [/INST]
345
+
346
+ """
347
+
348
+ tokenized_prompt = tokenizer(prompt, return_tensors="pt")
349
+
350
+ model.eval()
351
+ with torch.no_grad():
352
+ print(tokenizer.decode(
353
+ model.generate(**tokenized_prompt, max_new_tokens=200)[0],
354
+ skip_special_tokens=True))
355
+ ```
356
+
357
+ Generated output:
358
+ > The reason for calling in this conversation is for the agent to help the client regain access to their internet account, which has been locked due to an expired identification document. The agent asks for the client's personal information to confirm their identity and then informs them that their account has been blocked because they have not notified the bank about the ID change for a few months. The agent explains that the bank has displayed relevant messages about the ID expiring and that the client must produce a new identification document at one of their branches in order to unlock their account. The client expresses uncertainty about sharing their information with the agent, but ultimately decides to end the call.
359
+
360
+ To get the expected features and performance for the chat versions, a specific Llama 2 formatting needs to be followed, including the `INST` and `<<SYS>>` tags, `BOS` and `EOS` tokens, and the whitespaces and breaklines in between (we recommend calling `strip()` on inputs to avoid double-spaces). See reference code in github for details: [`chat_completion`](https://github.com/facebookresearch/llama/blob/main/llama/generation.py#L212).
361
+
362
+ # Authors
363
+
364
+ The model was trained by NLP Research Team at Voicelab.ai.
365
+
366
+ You can contact us [here](https://voicelab.ai/contact/).
367
+
368
+ * [TRURL 13b](https://huggingface.co/Voicelab/trurl-2-13b/)
369
+ * [TRURL 7b](https://huggingface.co/Voicelab/trurl-2-7b/)
370
+ * [TRURL DEMO](https://trurl.ai)
371
+
372
+ Quantized models:
373
+ * [TRURL 13b - 8bit](https://huggingface.co/Voicelab/trurl-2-13b-8bit/)
374
+ * [TRURL 7b - 8bit](https://huggingface.co/Voicelab/trurl-2-7b-8bit/)
375
+
376
+ The work was supported by [#NASK](https://www.nask.pl/)
377
+
378
+
379
+ <!-- original-model-card end -->