alquimista888 commited on
Commit
862d843
1 Parent(s): 156fcbe

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +88 -0
README.md ADDED
@@ -0,0 +1,88 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ pipeline_tag: text-generation
4
+ tags:
5
+ - finetuned
6
+ inference: true
7
+ widget:
8
+ - messages:
9
+ - role: user
10
+ content: What is your favorite condiment?
11
+ ---
12
+
13
+ # Model Card for Mistral-7B-Instruct-v0.2
14
+
15
+ The Mistral-7B-Instruct-v0.2 Large Language Model (LLM) is an instruct fine-tuned version of the Mistral-7B-v0.2.
16
+
17
+ Mistral-7B-v0.2 has the following changes compared to Mistral-7B-v0.1
18
+ - 32k context window (vs 8k context in v0.1)
19
+ - Rope-theta = 1e6
20
+ - No Sliding-Window Attention
21
+
22
+ For full details of this model please read our [paper](https://arxiv.org/abs/2310.06825) and [release blog post](https://mistral.ai/news/la-plateforme/).
23
+
24
+ ## Instruction format
25
+
26
+ In order to leverage instruction fine-tuning, your prompt should be surrounded by `[INST]` and `[/INST]` tokens. The very first instruction should begin with a begin of sentence id. The next instructions should not. The assistant generation will be ended by the end-of-sentence token id.
27
+
28
+ E.g.
29
+ ```
30
+ text = "<s>[INST] What is your favourite condiment? [/INST]"
31
+ "Well, I'm quite partial to a good squeeze of fresh lemon juice. It adds just the right amount of zesty flavour to whatever I'm cooking up in the kitchen!</s> "
32
+ "[INST] Do you have mayonnaise recipes? [/INST]"
33
+ ```
34
+
35
+ This format is available as a [chat template](https://huggingface.co/docs/transformers/main/chat_templating) via the `apply_chat_template()` method:
36
+
37
+ ```python
38
+ from transformers import AutoModelForCausalLM, AutoTokenizer
39
+
40
+ device = "cuda" # the device to load the model onto
41
+
42
+ model = AutoModelForCausalLM.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2")
43
+ tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2")
44
+
45
+ messages = [
46
+ {"role": "user", "content": "What is your favourite condiment?"},
47
+ {"role": "assistant", "content": "Well, I'm quite partial to a good squeeze of fresh lemon juice. It adds just the right amount of zesty flavour to whatever I'm cooking up in the kitchen!"},
48
+ {"role": "user", "content": "Do you have mayonnaise recipes?"}
49
+ ]
50
+
51
+ encodeds = tokenizer.apply_chat_template(messages, return_tensors="pt")
52
+
53
+ model_inputs = encodeds.to(device)
54
+ model.to(device)
55
+
56
+ generated_ids = model.generate(model_inputs, max_new_tokens=1000, do_sample=True)
57
+ decoded = tokenizer.batch_decode(generated_ids)
58
+ print(decoded[0])
59
+ ```
60
+
61
+ ## Troubleshooting
62
+ - If you see the following error:
63
+ ```
64
+ Traceback (most recent call last):
65
+ File "", line 1, in
66
+ File "/transformers/models/auto/auto_factory.py", line 482, in from_pretrained
67
+ config, kwargs = AutoConfig.from_pretrained(
68
+ File "/transformers/models/auto/configuration_auto.py", line 1022, in from_pretrained
69
+ config_class = CONFIG_MAPPING[config_dict["model_type"]]
70
+ File "/transformers/models/auto/configuration_auto.py", line 723, in getitem
71
+ raise KeyError(key)
72
+ KeyError: 'mistral'
73
+ ```
74
+
75
+ Installing transformers from source should solve the issue
76
+ pip install git+https://github.com/huggingface/transformers
77
+
78
+ This should not be required after transformers-v4.33.4.
79
+
80
+ ## Limitations
81
+
82
+ The Mistral 7B Instruct model is a quick demonstration that the base model can be easily fine-tuned to achieve compelling performance.
83
+ It does not have any moderation mechanisms. We're looking forward to engaging with the community on ways to
84
+ make the model finely respect guardrails, allowing for deployment in environments requiring moderated outputs.
85
+
86
+ ## The Mistral AI Team
87
+
88
+ Albert Jiang, Alexandre Sablayrolles, Arthur Mensch, Blanche Savary, Chris Bamford, Devendra Singh Chaplot, Diego de las Casas, Emma Bou Hanna, Florian Bressand, Gianna Lengyel, Guillaume Bour, Guillaume Lample, Lélio Renard Lavaud, Louis Ternon, Lucile Saulnier, Marie-Anne Lachaux, Pierre Stock, Teven Le Scao, Théophile Gervet, Thibaut Lavril, Thomas Wang, Timothée Lacroix, William El Sayed.