audreyt commited on
Commit
8996e6d
1 Parent(s): cf06917

* update model card

Browse files
Files changed (1) hide show
  1. README.md +249 -0
README.md CHANGED
@@ -1,3 +1,252 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ language:
4
+ - zh
5
+ widget:
6
+ - text: >-
7
+ A chat between a curious user and an artificial intelligence assistant.
8
+ The assistant gives helpful, detailed, and polite answers to the user's
9
+ questions. USER: 你好,請問你可以幫我寫一封推薦信嗎? ASSISTANT:
10
+ library_name: transformers
11
+ pipeline_tag: text-generation
12
  ---
13
+
14
+ <!-- header start -->
15
+ <!-- header end -->
16
+
17
+ # Taiwan-LLM-7B-v2.0-chat - GGUF
18
+ - Model creator: [Yen-Ting Lin](https://huggingface.co/yentinglin)
19
+ - Original model: [Taiwan-LLM-7B-v2.0-chat](https://huggingface.co/yentinglin/Taiwan-LLM-7B-v2.0-chat)
20
+
21
+ ## Description
22
+
23
+ This repo contains GGUF format model files for Yen-Ting Lin's [Taiwan LLM based on LLaMa2-7b v2.0-chat](https://huggingface.co/yentinglin/Taiwan-LLM-7B-v2.0-chat).
24
+
25
+ ## About GGUF
26
+
27
+ 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.
28
+
29
+ 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.
30
+
31
+ As of August 25th, here is a list of clients and libraries that are known to support GGUF:
32
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp).
33
+ * [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.
34
+ * [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.
35
+ * [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.
36
+ * [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.
37
+ * [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.
38
+ * [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.
39
+ * [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.
40
+
41
+ <!-- footer start -->
42
+ <!-- footer end -->
43
+
44
+ # Original model card
45
+
46
+ ---
47
+ # For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
48
+ # Doc / guide: https://huggingface.co/docs/hub/model-cards
49
+
50
+ # Taiwan LLM based on LLaMa2-7b
51
+
52
+ continue pretraining on 20 billion tokens in traditional mandarin and instruction fine-tuning on millions of conversations.
53
+
54
+ This version does NOT include commoncrawl.
55
+
56
+ # 🌟 Checkout New [Taiwan-LLM UI](http://www.twllm.com) 🌟
57
+
58
+ # Model Card for Model ID
59
+
60
+ <!-- Provide a quick summary of what the model is/does. -->
61
+
62
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
63
+
64
+ ## Model Details
65
+
66
+ ### Model Description
67
+
68
+ <!-- Provide a longer summary of what this model is. -->
69
+
70
+
71
+
72
+ - **Developed by:** [More Information Needed]
73
+ - **Shared by [optional]:** [More Information Needed]
74
+ - **Model type:** [More Information Needed]
75
+ - **Language(s) (NLP):** [More Information Needed]
76
+ - **License:** [More Information Needed]
77
+ - **Finetuned from model [optional]:** [More Information Needed]
78
+
79
+ ### Model Sources [optional]
80
+
81
+ <!-- Provide the basic links for the model. -->
82
+
83
+ - **Repository:** [More Information Needed]
84
+ - **Paper [optional]:** [More Information Needed]
85
+ - **Demo [optional]:** [More Information Needed]
86
+
87
+ ## Uses
88
+
89
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
90
+
91
+ ### Direct Use
92
+
93
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
94
+
95
+ [More Information Needed]
96
+
97
+ ### Downstream Use [optional]
98
+
99
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
100
+
101
+ [More Information Needed]
102
+
103
+ ### Out-of-Scope Use
104
+
105
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
106
+
107
+ [More Information Needed]
108
+
109
+ ## Bias, Risks, and Limitations
110
+
111
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
112
+
113
+ [More Information Needed]
114
+
115
+ ### Recommendations
116
+
117
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
118
+
119
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
120
+
121
+ ## How to Get Started with the Model
122
+
123
+ Use the code below to get started with the model.
124
+
125
+ [More Information Needed]
126
+
127
+ ## Training Details
128
+
129
+ ### Training Data
130
+
131
+ <!-- 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. -->
132
+
133
+ [More Information Needed]
134
+
135
+ ### Training Procedure
136
+
137
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
138
+
139
+ #### Preprocessing [optional]
140
+
141
+ [More Information Needed]
142
+
143
+
144
+ #### Training Hyperparameters
145
+
146
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
147
+
148
+ #### Speeds, Sizes, Times [optional]
149
+
150
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
151
+
152
+ [More Information Needed]
153
+
154
+ ## Evaluation
155
+
156
+ <!-- This section describes the evaluation protocols and provides the results. -->
157
+
158
+ ### Testing Data, Factors & Metrics
159
+
160
+ #### Testing Data
161
+
162
+ <!-- This should link to a Data Card if possible. -->
163
+
164
+ [More Information Needed]
165
+
166
+ #### Factors
167
+
168
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
169
+
170
+ [More Information Needed]
171
+
172
+ #### Metrics
173
+
174
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
175
+
176
+ [More Information Needed]
177
+
178
+ ### Results
179
+
180
+ [More Information Needed]
181
+
182
+ #### Summary
183
+
184
+
185
+
186
+ ## Model Examination [optional]
187
+
188
+ <!-- Relevant interpretability work for the model goes here -->
189
+
190
+ [More Information Needed]
191
+
192
+ ## Environmental Impact
193
+
194
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
195
+
196
+ 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).
197
+
198
+ - **Hardware Type:** [More Information Needed]
199
+ - **Hours used:** [More Information Needed]
200
+ - **Cloud Provider:** [More Information Needed]
201
+ - **Compute Region:** [More Information Needed]
202
+ - **Carbon Emitted:** [More Information Needed]
203
+
204
+ ## Technical Specifications [optional]
205
+
206
+ ### Model Architecture and Objective
207
+
208
+ [More Information Needed]
209
+
210
+ ### Compute Infrastructure
211
+
212
+ [More Information Needed]
213
+
214
+ #### Hardware
215
+
216
+ [More Information Needed]
217
+
218
+ #### Software
219
+
220
+ [More Information Needed]
221
+
222
+ ## Citation [optional]
223
+
224
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
225
+
226
+ **BibTeX:**
227
+
228
+ [More Information Needed]
229
+
230
+ **APA:**
231
+
232
+ [More Information Needed]
233
+
234
+ ## Glossary [optional]
235
+
236
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
237
+
238
+ [More Information Needed]
239
+
240
+ ## More Information [optional]
241
+
242
+ [More Information Needed]
243
+
244
+ ## Model Card Authors [optional]
245
+
246
+ [More Information Needed]
247
+
248
+ ## Model Card Contact
249
+
250
+ [More Information Needed]
251
+
252
+