gmverdon commited on
Commit
3d6f161
1 Parent(s): e604a12

Add readme

Browse files
Files changed (1) hide show
  1. README.md +232 -0
README.md ADDED
@@ -0,0 +1,232 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ # For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
3
+ # Doc / guide: https://huggingface.co/docs/hub/model-cards
4
+ {}
5
+ ---
6
+
7
+ # Llama Gaan 2 7B Chat HF Dutch
8
+
9
+ <!-- Provide a quick summary of what the model is/does. -->
10
+
11
+ This model is a finetuned version of [LLAMA 2 7B Chat](https://huggingface.co/daryl149/llama-2-7b-chat-hf) aiming for Dutch language support 🇳🇱.
12
+ Courtesy of [Mirage Studio](https://www.mirage-studio.io), home of MirageGPT: the private ChatGPT alternative.
13
+
14
+
15
+
16
+ ## Model Details
17
+
18
+ ### Model Description
19
+
20
+ <!-- Provide a longer summary of what this model is. -->
21
+
22
+
23
+
24
+ - **Developed by:** [More Information Needed]
25
+ - **Shared by [optional]:** [More Information Needed]
26
+ - **Model type:** [More Information Needed]
27
+ - **Language(s) (NLP):** [More Information Needed]
28
+ - **License:** [More Information Needed]
29
+ - **Finetuned from model [optional]:** [More Information Needed]
30
+
31
+ ### Prompt template
32
+
33
+ ```
34
+ <s>[INST] <<SYS>>
35
+ System prompt
36
+ <</SYS>>
37
+
38
+ User prompt [/INST] Model answer </s>
39
+ ```
40
+
41
+ To continue a conversation
42
+
43
+ ```
44
+ [INST] <<SYS>>
45
+ 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.
46
+ <</SYS>>
47
+
48
+ {prompt} [/INST] {model_reply} [INST] {prompt} [/INST]
49
+ ```
50
+
51
+ ### Example usage
52
+ An example question you can ask:
53
+
54
+ Q: Kun je aangeven wat het belang van privacy is voor bedrijven?
55
+
56
+ A: Het belang van privacy voor bedrijven is dat ze hun klanten moeten beschermen tegen onverhoopt gebruik van persoonlijke gegevens die kunnen leiden tot verlies van privacy, strafrechtelijke problemen of reputatieschade. Bedrijven hebben de plicht om hun klanten te informeren over hoe hun gegevens worden gebruikt en welke middelen zijn beschikbaar om deze te beschermen. Bovendien moeten bedrijven zich aan de wetten houden die relevante privacybeveiligingsmaatregelen regelen, zoals GDPR (General Data Protection Regulation) in Europa. Privacy is essentieel voor het bouwen van betrouw en vertrouwen tussen bedrijven en hun klanten, waardoor bedrijven kunnen concurreren in een markt met strengere eisen. In het algemeen kan men zeggen dat privacy een cruciaal aspect is bij het ontwikkelen van succesvolle bedrijfsstrategies.
57
+
58
+
59
+ ### Model Sources [optional]
60
+
61
+ <!-- Provide the basic links for the model. -->
62
+
63
+ - **Repository:** [More Information Needed]
64
+ - **Paper [optional]:** [More Information Needed]
65
+ - **Demo [optional]:** [More Information Needed]
66
+
67
+ ## Uses
68
+
69
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
70
+
71
+ ### Direct Use
72
+
73
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
74
+
75
+ [More Information Needed]
76
+
77
+ ### Downstream Use [optional]
78
+
79
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
80
+
81
+ [More Information Needed]
82
+
83
+ ### Out-of-Scope Use
84
+
85
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
86
+
87
+ [More Information Needed]
88
+
89
+ ## Bias, Risks, and Limitations
90
+
91
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
92
+
93
+ [More Information Needed]
94
+
95
+ ### Recommendations
96
+
97
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
98
+
99
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
100
+
101
+ ## How to Get Started with the Model
102
+
103
+ Use the code below to get started with the model.
104
+
105
+ [More Information Needed]
106
+
107
+ ## Training Details
108
+
109
+ ### Training Data
110
+
111
+ <!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
112
+
113
+ [More Information Needed]
114
+
115
+ ### Training Procedure
116
+
117
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
118
+
119
+ #### Preprocessing [optional]
120
+
121
+ [More Information Needed]
122
+
123
+
124
+ #### Training Hyperparameters
125
+
126
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
127
+
128
+ #### Speeds, Sizes, Times [optional]
129
+
130
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
131
+
132
+ [More Information Needed]
133
+
134
+ ## Evaluation
135
+
136
+ <!-- This section describes the evaluation protocols and provides the results. -->
137
+
138
+ ### Testing Data, Factors & Metrics
139
+
140
+ #### Testing Data
141
+
142
+ <!-- This should link to a Data Card if possible. -->
143
+
144
+ [More Information Needed]
145
+
146
+ #### Factors
147
+
148
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
149
+
150
+ [More Information Needed]
151
+
152
+ #### Metrics
153
+
154
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
155
+
156
+ [More Information Needed]
157
+
158
+ ### Results
159
+
160
+ [More Information Needed]
161
+
162
+ #### Summary
163
+
164
+
165
+
166
+ ## Model Examination [optional]
167
+
168
+ <!-- Relevant interpretability work for the model goes here -->
169
+
170
+ [More Information Needed]
171
+
172
+ ## Environmental Impact
173
+
174
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
175
+
176
+ Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
177
+
178
+ - **Hardware Type:** [More Information Needed]
179
+ - **Hours used:** [More Information Needed]
180
+ - **Cloud Provider:** [More Information Needed]
181
+ - **Compute Region:** [More Information Needed]
182
+ - **Carbon Emitted:** [More Information Needed]
183
+
184
+ ## Technical Specifications [optional]
185
+
186
+ ### Model Architecture and Objective
187
+
188
+ [More Information Needed]
189
+
190
+ ### Compute Infrastructure
191
+
192
+ [More Information Needed]
193
+
194
+ #### Hardware
195
+
196
+ [More Information Needed]
197
+
198
+ #### Software
199
+
200
+ [More Information Needed]
201
+
202
+ ## Citation [optional]
203
+
204
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
205
+
206
+ **BibTeX:**
207
+
208
+ [More Information Needed]
209
+
210
+ **APA:**
211
+
212
+ [More Information Needed]
213
+
214
+ ## Glossary [optional]
215
+
216
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
217
+
218
+ [More Information Needed]
219
+
220
+ ## More Information [optional]
221
+
222
+ [More Information Needed]
223
+
224
+ ## Model Card Authors [optional]
225
+
226
+ [More Information Needed]
227
+
228
+ ## Model Card Contact
229
+
230
+ [More Information Needed]
231
+
232
+