RichardErkhov commited on
Commit
c405dd5
·
verified ·
1 Parent(s): c8fa744

uploaded readme

Browse files
Files changed (1) hide show
  1. README.md +245 -0
README.md ADDED
@@ -0,0 +1,245 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Quantization made by Richard Erkhov.
2
+
3
+ [Github](https://github.com/RichardErkhov)
4
+
5
+ [Discord](https://discord.gg/pvy7H8DZMG)
6
+
7
+ [Request more models](https://github.com/RichardErkhov/quant_request)
8
+
9
+
10
+ BM25Chunk - GGUF
11
+ - Model creator: https://huggingface.co/yuzhaouoe/
12
+ - Original model: https://huggingface.co/yuzhaouoe/BM25Chunk/
13
+
14
+
15
+ | Name | Quant method | Size |
16
+ | ---- | ---- | ---- |
17
+ | [BM25Chunk.Q2_K.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q2_K.gguf) | Q2_K | 0.52GB |
18
+ | [BM25Chunk.Q3_K_S.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q3_K_S.gguf) | Q3_K_S | 0.6GB |
19
+ | [BM25Chunk.Q3_K.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q3_K.gguf) | Q3_K | 0.65GB |
20
+ | [BM25Chunk.Q3_K_M.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q3_K_M.gguf) | Q3_K_M | 0.65GB |
21
+ | [BM25Chunk.Q3_K_L.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q3_K_L.gguf) | Q3_K_L | 0.69GB |
22
+ | [BM25Chunk.IQ4_XS.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.IQ4_XS.gguf) | IQ4_XS | 0.7GB |
23
+ | [BM25Chunk.Q4_0.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q4_0.gguf) | Q4_0 | 0.72GB |
24
+ | [BM25Chunk.IQ4_NL.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.IQ4_NL.gguf) | IQ4_NL | 0.73GB |
25
+ | [BM25Chunk.Q4_K_S.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q4_K_S.gguf) | Q4_K_S | 0.76GB |
26
+ | [BM25Chunk.Q4_K.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q4_K.gguf) | Q4_K | 0.81GB |
27
+ | [BM25Chunk.Q4_K_M.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q4_K_M.gguf) | Q4_K_M | 0.81GB |
28
+ | [BM25Chunk.Q4_1.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q4_1.gguf) | Q4_1 | 0.8GB |
29
+ | [BM25Chunk.Q5_0.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q5_0.gguf) | Q5_0 | 0.87GB |
30
+ | [BM25Chunk.Q5_K_S.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q5_K_S.gguf) | Q5_K_S | 0.89GB |
31
+ | [BM25Chunk.Q5_K.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q5_K.gguf) | Q5_K | 0.93GB |
32
+ | [BM25Chunk.Q5_K_M.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q5_K_M.gguf) | Q5_K_M | 0.93GB |
33
+ | [BM25Chunk.Q5_1.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q5_1.gguf) | Q5_1 | 0.95GB |
34
+ | [BM25Chunk.Q6_K.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q6_K.gguf) | Q6_K | 1.09GB |
35
+ | [BM25Chunk.Q8_0.gguf](https://huggingface.co/RichardErkhov/yuzhaouoe_-_BM25Chunk-gguf/blob/main/BM25Chunk.Q8_0.gguf) | Q8_0 | 1.33GB |
36
+
37
+
38
+
39
+
40
+ Original model description:
41
+ ---
42
+ library_name: transformers
43
+ tags: []
44
+ ---
45
+
46
+ # Model Card for Model ID
47
+
48
+ <!-- Provide a quick summary of what the model is/does. -->
49
+
50
+
51
+
52
+ ## Model Details
53
+
54
+ ### Model Description
55
+
56
+ <!-- Provide a longer summary of what this model is. -->
57
+
58
+ This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
59
+
60
+ - **Developed by:** [More Information Needed]
61
+ - **Funded by [optional]:** [More Information Needed]
62
+ - **Shared by [optional]:** [More Information Needed]
63
+ - **Model type:** [More Information Needed]
64
+ - **Language(s) (NLP):** [More Information Needed]
65
+ - **License:** [More Information Needed]
66
+ - **Finetuned from model [optional]:** [More Information Needed]
67
+
68
+ ### Model Sources [optional]
69
+
70
+ <!-- Provide the basic links for the model. -->
71
+
72
+ - **Repository:** [More Information Needed]
73
+ - **Paper [optional]:** [More Information Needed]
74
+ - **Demo [optional]:** [More Information Needed]
75
+
76
+ ## Uses
77
+
78
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
79
+
80
+ ### Direct Use
81
+
82
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
83
+
84
+ [More Information Needed]
85
+
86
+ ### Downstream Use [optional]
87
+
88
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
89
+
90
+ [More Information Needed]
91
+
92
+ ### Out-of-Scope Use
93
+
94
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
95
+
96
+ [More Information Needed]
97
+
98
+ ## Bias, Risks, and Limitations
99
+
100
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
101
+
102
+ [More Information Needed]
103
+
104
+ ### Recommendations
105
+
106
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
107
+
108
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
109
+
110
+ ## How to Get Started with the Model
111
+
112
+ Use the code below to get started with the model.
113
+
114
+ [More Information Needed]
115
+
116
+ ## Training Details
117
+
118
+ ### Training Data
119
+
120
+ <!-- This should link to a Dataset 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. -->
121
+
122
+ [More Information Needed]
123
+
124
+ ### Training Procedure
125
+
126
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
127
+
128
+ #### Preprocessing [optional]
129
+
130
+ [More Information Needed]
131
+
132
+
133
+ #### Training Hyperparameters
134
+
135
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
136
+
137
+ #### Speeds, Sizes, Times [optional]
138
+
139
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
140
+
141
+ [More Information Needed]
142
+
143
+ ## Evaluation
144
+
145
+ <!-- This section describes the evaluation protocols and provides the results. -->
146
+
147
+ ### Testing Data, Factors & Metrics
148
+
149
+ #### Testing Data
150
+
151
+ <!-- This should link to a Dataset Card if possible. -->
152
+
153
+ [More Information Needed]
154
+
155
+ #### Factors
156
+
157
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
158
+
159
+ [More Information Needed]
160
+
161
+ #### Metrics
162
+
163
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
164
+
165
+ [More Information Needed]
166
+
167
+ ### Results
168
+
169
+ [More Information Needed]
170
+
171
+ #### Summary
172
+
173
+
174
+
175
+ ## Model Examination [optional]
176
+
177
+ <!-- Relevant interpretability work for the model goes here -->
178
+
179
+ [More Information Needed]
180
+
181
+ ## Environmental Impact
182
+
183
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
184
+
185
+ 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).
186
+
187
+ - **Hardware Type:** [More Information Needed]
188
+ - **Hours used:** [More Information Needed]
189
+ - **Cloud Provider:** [More Information Needed]
190
+ - **Compute Region:** [More Information Needed]
191
+ - **Carbon Emitted:** [More Information Needed]
192
+
193
+ ## Technical Specifications [optional]
194
+
195
+ ### Model Architecture and Objective
196
+
197
+ [More Information Needed]
198
+
199
+ ### Compute Infrastructure
200
+
201
+ [More Information Needed]
202
+
203
+ #### Hardware
204
+
205
+ [More Information Needed]
206
+
207
+ #### Software
208
+
209
+ [More Information Needed]
210
+
211
+ ## Citation [optional]
212
+
213
+ **BibTeX:**
214
+
215
+ ```
216
+ @article{zhao2024analysing,
217
+ title={Analysing The Impact of Sequence Composition on Language Model Pre-Training},
218
+ author={Zhao, Yu and Qu, Yuanbin and Staniszewski, Konrad and Tworkowski, Szymon and Liu, Wei and Mi{\l}o{\'s}, Piotr and Wu, Yuxiang and Minervini, Pasquale},
219
+ journal={arXiv preprint arXiv:2402.13991},
220
+ year={2024}
221
+ }
222
+ ```
223
+
224
+ **APA:**
225
+
226
+ [More Information Needed]
227
+
228
+ ## Glossary [optional]
229
+
230
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
231
+
232
+ [More Information Needed]
233
+
234
+ ## More Information [optional]
235
+
236
+ [More Information Needed]
237
+
238
+ ## Model Card Authors [optional]
239
+
240
+ [More Information Needed]
241
+
242
+ ## Model Card Contact
243
+
244
+ [More Information Needed]
245
+