JARINJV commited on
Commit
95ec0be
1 Parent(s): 7c3352b

Upload folder using huggingface_hub

Browse files
.gitattributes CHANGED
@@ -33,3 +33,5 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ mistral-7b-instruct-v0.3.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
37
+ mistral-7b-instruct-v0.3.bf16.gguf filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,196 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ tags:
4
+ - autoquant
5
+ - gguf
6
+ extra_gated_description: If you want to learn more about how we process your personal
7
+ data, please read our <a href="https://mistral.ai/terms/">Privacy Policy</a>.
8
+ ---
9
+
10
+ # Model Card for Mistral-7B-Instruct-v0.3
11
+
12
+ The Mistral-7B-Instruct-v0.3 Large Language Model (LLM) is an instruct fine-tuned version of the Mistral-7B-v0.3.
13
+
14
+ Mistral-7B-v0.3 has the following changes compared to [Mistral-7B-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2/edit/main/README.md)
15
+ - Extended vocabulary to 32768
16
+ - Supports v3 Tokenizer
17
+ - Supports function calling
18
+
19
+ ## Installation
20
+
21
+ It is recommended to use `mistralai/Mistral-7B-Instruct-v0.3` with [mistral-inference](https://github.com/mistralai/mistral-inference). For HF transformers code snippets, please keep scrolling.
22
+
23
+ ```
24
+ pip install mistral_inference
25
+ ```
26
+
27
+ ## Download
28
+
29
+ ```py
30
+ from huggingface_hub import snapshot_download
31
+ from pathlib import Path
32
+
33
+ mistral_models_path = Path.home().joinpath('mistral_models', '7B-Instruct-v0.3')
34
+ mistral_models_path.mkdir(parents=True, exist_ok=True)
35
+
36
+ snapshot_download(repo_id="mistralai/Mistral-7B-Instruct-v0.3", allow_patterns=["params.json", "consolidated.safetensors", "tokenizer.model.v3"], local_dir=mistral_models_path)
37
+ ```
38
+
39
+ ### Chat
40
+
41
+ After installing `mistral_inference`, a `mistral-chat` CLI command should be available in your environment. You can chat with the model using
42
+
43
+ ```
44
+ mistral-chat $HOME/mistral_models/7B-Instruct-v0.3 --instruct --max_tokens 256
45
+ ```
46
+
47
+ ### Instruct following
48
+
49
+ ```py
50
+ from mistral_inference.transformer import Transformer
51
+ from mistral_inference.generate import generate
52
+
53
+ from mistral_common.tokens.tokenizers.mistral import MistralTokenizer
54
+ from mistral_common.protocol.instruct.messages import UserMessage
55
+ from mistral_common.protocol.instruct.request import ChatCompletionRequest
56
+
57
+
58
+ tokenizer = MistralTokenizer.from_file(f"{mistral_models_path}/tokenizer.model.v3")
59
+ model = Transformer.from_folder(mistral_models_path)
60
+
61
+ completion_request = ChatCompletionRequest(messages=[UserMessage(content="Explain Machine Learning to me in a nutshell.")])
62
+
63
+ tokens = tokenizer.encode_chat_completion(completion_request).tokens
64
+
65
+ out_tokens, _ = generate([tokens], model, max_tokens=64, temperature=0.0, eos_id=tokenizer.instruct_tokenizer.tokenizer.eos_id)
66
+ result = tokenizer.instruct_tokenizer.tokenizer.decode(out_tokens[0])
67
+
68
+ print(result)
69
+ ```
70
+
71
+ ### Function calling
72
+
73
+ ```py
74
+ from mistral_common.protocol.instruct.tool_calls import Function, Tool
75
+ from mistral_inference.transformer import Transformer
76
+ from mistral_inference.generate import generate
77
+
78
+ from mistral_common.tokens.tokenizers.mistral import MistralTokenizer
79
+ from mistral_common.protocol.instruct.messages import UserMessage
80
+ from mistral_common.protocol.instruct.request import ChatCompletionRequest
81
+
82
+
83
+ tokenizer = MistralTokenizer.from_file(f"{mistral_models_path}/tokenizer.model.v3")
84
+ model = Transformer.from_folder(mistral_models_path)
85
+
86
+ completion_request = ChatCompletionRequest(
87
+ tools=[
88
+ Tool(
89
+ function=Function(
90
+ name="get_current_weather",
91
+ description="Get the current weather",
92
+ parameters={
93
+ "type": "object",
94
+ "properties": {
95
+ "location": {
96
+ "type": "string",
97
+ "description": "The city and state, e.g. San Francisco, CA",
98
+ },
99
+ "format": {
100
+ "type": "string",
101
+ "enum": ["celsius", "fahrenheit"],
102
+ "description": "The temperature unit to use. Infer this from the users location.",
103
+ },
104
+ },
105
+ "required": ["location", "format"],
106
+ },
107
+ )
108
+ )
109
+ ],
110
+ messages=[
111
+ UserMessage(content="What's the weather like today in Paris?"),
112
+ ],
113
+ )
114
+
115
+ tokens = tokenizer.encode_chat_completion(completion_request).tokens
116
+
117
+ out_tokens, _ = generate([tokens], model, max_tokens=64, temperature=0.0, eos_id=tokenizer.instruct_tokenizer.tokenizer.eos_id)
118
+ result = tokenizer.instruct_tokenizer.tokenizer.decode(out_tokens[0])
119
+
120
+ print(result)
121
+ ```
122
+
123
+ ## Generate with `transformers`
124
+
125
+ If you want to use Hugging Face `transformers` to generate text, you can do something like this.
126
+
127
+ ```py
128
+ from transformers import pipeline
129
+
130
+ messages = [
131
+ {"role": "system", "content": "You are a pirate chatbot who always responds in pirate speak!"},
132
+ {"role": "user", "content": "Who are you?"},
133
+ ]
134
+ chatbot = pipeline("text-generation", model="mistralai/Mistral-7B-Instruct-v0.3")
135
+ chatbot(messages)
136
+ ```
137
+
138
+
139
+ ## Function calling with `transformers`
140
+
141
+ To use this example, you'll need `transformers` version 4.42.0 or higher. Please see the
142
+ [function calling guide](https://huggingface.co/docs/transformers/main/chat_templating#advanced-tool-use--function-calling)
143
+ in the `transformers` docs for more information.
144
+
145
+ ```python
146
+ from transformers import AutoModelForCausalLM, AutoTokenizer
147
+ import torch
148
+
149
+ model_id = "mistralai/Mistral-7B-Instruct-v0.3"
150
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
151
+
152
+ def get_current_weather(location: str, format: str):
153
+ """
154
+ Get the current weather
155
+
156
+ Args:
157
+ location: The city and state, e.g. San Francisco, CA
158
+ format: The temperature unit to use. Infer this from the users location. (choices: ["celsius", "fahrenheit"])
159
+ """
160
+ pass
161
+
162
+ conversation = [{"role": "user", "content": "What's the weather like in Paris?"}]
163
+ tools = [get_current_weather]
164
+
165
+ # render the tool use prompt as a string:
166
+ tool_use_prompt = tokenizer.apply_chat_template(
167
+ conversation,
168
+ tools=tools,
169
+ tokenize=False,
170
+ add_generation_prompt=True,
171
+ )
172
+
173
+ inputs = tokenizer(tool_use_prompt, return_tensors="pt")
174
+
175
+ model = AutoModelForCausalLM.from_pretrained(model_id, torch_dtype=torch.bfloat16, device_map="auto")
176
+
177
+ outputs = model.generate(**inputs, max_new_tokens=1000)
178
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
179
+ ```
180
+
181
+ Note that, for reasons of space, this example does not show a complete cycle of calling a tool and adding the tool call and tool
182
+ results to the chat history so that the model can use them in its next generation. For a full tool calling example, please
183
+ see the [function calling guide](https://huggingface.co/docs/transformers/main/chat_templating#advanced-tool-use--function-calling),
184
+ and note that Mistral **does** use tool call IDs, so these must be included in your tool calls and tool results. They should be
185
+ exactly 9 alphanumeric characters.
186
+
187
+
188
+ ## Limitations
189
+
190
+ The Mistral 7B Instruct model is a quick demonstration that the base model can be easily fine-tuned to achieve compelling performance.
191
+ It does not have any moderation mechanisms. We're looking forward to engaging with the community on ways to
192
+ make the model finely respect guardrails, allowing for deployment in environments requiring moderated outputs.
193
+
194
+ ## The Mistral AI Team
195
+
196
+ Albert Jiang, Alexandre Sablayrolles, Alexis Tacnet, Antoine Roux, Arthur Mensch, Audrey Herblin-Stoop, Baptiste Bout, Baudouin de Monicault, Blanche Savary, Bam4d, Caroline Feldman, Devendra Singh Chaplot, Diego de las Casas, Eleonore Arcelin, Emma Bou Hanna, Etienne Metzger, Gianna Lengyel, Guillaume Bour, Guillaume Lample, Harizo Rajaona, Jean-Malo Delignon, Jia Li, Justus Murke, Louis Martin, Louis Ternon, Lucile Saulnier, Lélio Renard Lavaud, Margaret Jennings, Marie Pellat, Marie Torelli, Marie-Anne Lachaux, Nicolas Schuhl, Patrick von Platen, Pierre Stock, Sandeep Subramanian, Sophia Yang, Szymon Antoniak, Teven Le Scao, Thibaut Lavril, Timothée Lacroix, Théophile Gervet, Thomas Wang, Valera Nemychnikova, William El Sayed, William Marshall
mistral-7b-instruct-v0.3.Q5_K_M.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:55b5990a09063db96b55f1580199a3bbea50d78e2cbaddcc72ca5f112f55350a
3
+ size 5136178816
mistral-7b-instruct-v0.3.bf16.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:5f828be62045c220ebdce81502c6f7738de089fde094ba7a4a0de80c362279b3
3
+ size 14497341056