johannhartmann commited on
Commit
a80c363
1 Parent(s): f70dd0d

Upload folder using huggingface_hub

Browse files
.gitattributes CHANGED
@@ -1,35 +1,10 @@
1
- *.7z filter=lfs diff=lfs merge=lfs -text
2
- *.arrow filter=lfs diff=lfs merge=lfs -text
3
  *.bin filter=lfs diff=lfs merge=lfs -text
4
- *.bz2 filter=lfs diff=lfs merge=lfs -text
5
- *.ckpt filter=lfs diff=lfs merge=lfs -text
6
- *.ftz filter=lfs diff=lfs merge=lfs -text
7
- *.gz filter=lfs diff=lfs merge=lfs -text
8
- *.h5 filter=lfs diff=lfs merge=lfs -text
9
- *.joblib filter=lfs diff=lfs merge=lfs -text
10
- *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
- *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
  *.model filter=lfs diff=lfs merge=lfs -text
13
- *.msgpack filter=lfs diff=lfs merge=lfs -text
14
- *.npy filter=lfs diff=lfs merge=lfs -text
15
- *.npz filter=lfs diff=lfs merge=lfs -text
16
- *.onnx filter=lfs diff=lfs merge=lfs -text
17
- *.ot filter=lfs diff=lfs merge=lfs -text
18
- *.parquet filter=lfs diff=lfs merge=lfs -text
19
- *.pb filter=lfs diff=lfs merge=lfs -text
20
- *.pickle filter=lfs diff=lfs merge=lfs -text
21
- *.pkl filter=lfs diff=lfs merge=lfs -text
22
- *.pt filter=lfs diff=lfs merge=lfs -text
23
- *.pth filter=lfs diff=lfs merge=lfs -text
24
- *.rar filter=lfs diff=lfs merge=lfs -text
25
- *.safetensors filter=lfs diff=lfs merge=lfs -text
26
- saved_model/**/* filter=lfs diff=lfs merge=lfs -text
27
- *.tar.* filter=lfs diff=lfs merge=lfs -text
28
- *.tar filter=lfs diff=lfs merge=lfs -text
29
- *.tflite filter=lfs diff=lfs merge=lfs -text
30
- *.tgz filter=lfs diff=lfs merge=lfs -text
31
- *.wasm filter=lfs diff=lfs merge=lfs -text
32
- *.xz 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
 
 
 
1
  *.bin filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
2
  *.model filter=lfs diff=lfs merge=lfs -text
3
+ model-00002-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
4
+ model-00005-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
5
+ model-00003-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
6
+ model-00001-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
7
+ model-00006-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
8
+ model-00008-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
9
+ model-00004-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
10
+ model-00007-of-00008.safetensors filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
LICENSE ADDED
@@ -0,0 +1,324 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Yi Series Models Community License Agreement
2
+ Version: 2.1
3
+ Date of Release: November 23, 2023
4
+
5
+ 1. Definition
6
+
7
+ “Agreement” refers to the terms and conditions defined in this Yi Series Models
8
+ Community License Agreement for the use, reproduction and distribution of Yi
9
+ Series Models.
10
+
11
+ “Model” refers to associated components (including checkpoints) developed based
12
+ on machine learning, including learned weights and parameters (including the
13
+ status of optimizer).
14
+
15
+ “Yi Series Models” refers to opensource models with different specifications and
16
+ capabilities named “Yi” provided by the Licensor, including Yi-6B, Yi-34B etc.
17
+
18
+ “Derivatives” refers to all modifications to Yi Series Models, work based on Yi
19
+ Series Models, or any other models created or initialized by transferring the
20
+ weights, parameters, activations, or output patterns of Yi Series Models to
21
+ other models to achieve similar performance, including but not limited to
22
+ methods that require using intermediate data representations or generating
23
+ synthetic data based on Yi Series Models to train other models.
24
+
25
+ “Licensor” refers to Beijing Lingyiwanwu Information Technology Co., Ltd.
26
+
27
+ “you” refers to an individual or legal entity that exercises the license granted
28
+ by this Agreement and/or uses the Yi Series Models for any purpose and in any
29
+ field of use.
30
+
31
+ “Third Party” refers to any individuals, legal entities or non-legal
32
+ organizations other than you.
33
+
34
+ “Distribute” refers to transmitting, copying, publishing, or otherwise sharing
35
+ the Yi Series Models with third parties, including providing the Yi Series
36
+ Models through electronic or other remote means (such as any SaaS software or
37
+ PaaS software accessed via API or web access).
38
+
39
+ “Commercial Purposes” refers to the use of the Yi Series Models, directly or
40
+ indirectly, for the operation, promotion, revenue generation, or any other
41
+ profit-making purposes for entities or individuals.
42
+
43
+ “Laws and Regulations” refers to the laws and administrative regulations of the
44
+ mainland of the People's Republic of China (for the purposes of this Agreement
45
+ only, excluding Hong Kong, Macau, and Taiwan).
46
+
47
+ “Personal Information” refers to various information related to identified or
48
+ identifiable natural persons recorded electronically or by other means,
49
+ excluding information that has been anonymized.
50
+
51
+ “Logo” refers to any trademark, service mark, trade name, domain name, website
52
+ name, or other distinctive branding marks.
53
+
54
+ 2. License and License Restrictions
55
+ The Licensor hereby grants you a non-exclusive, global, non-transferable,
56
+ non-sub-licensable, revocable, and royalty-free copyright license. You must
57
+ adhere to the following license restrictions:
58
+
59
+ 1) Your use of the Yi Series Models must comply with the Laws and Regulations as
60
+ well as applicable legal requirements of other countries/regions, and respect
61
+ social ethics and moral standards, including but not limited to, not using the
62
+ Yi Series Models for purposes prohibited by Laws and Regulations as well as
63
+ applicable legal requirements of other countries/regions, such as harming
64
+ national security, promoting terrorism, extremism, inciting ethnic or racial
65
+ hatred, discrimination, violence, or pornography, and spreading false harmful
66
+ information.
67
+
68
+ 2) You shall not, for military or unlawful purposes or in ways not allowed by
69
+ Laws and Regulations as well as applicable legal requirements of other
70
+ countries/regions, a) use, copy or Distribute the Yi Series Models, or b) create
71
+ complete or partial Derivatives of the Yi Series Models.
72
+
73
+ 3) Your use of the Yi Series Models (including using the output of the Yi Series
74
+ Models) and the creation of Derivatives must not infringe upon the legitimate
75
+ rights of any Third Party, including but not limited to the rights of personal
76
+ rights such as the right to likeness, reputation, and privacy, as well as
77
+ intellectual property rights such as copyrights, patents, trade secrets, and
78
+ other property rights.
79
+
80
+ 4) You must clearly attribute the source of the Yi Series Models to the Licensor
81
+ and provide a copy of this Agreement to any Third-Party users of the Yi Series
82
+ Models and Derivatives.
83
+
84
+ 5) If you modify the Yi Series Models to create Derivatives, you must clearly
85
+ indicate the substantial modifications made, and these modifications shall not
86
+ violate the license restrictions of this Agreement. You shall not enable,
87
+ assist, or in any way facilitate Third Parties to violate the license
88
+ restrictions of this Agreement.
89
+
90
+ If you plan to use the Yi Series Models and Derivatives for Commercial Purposes,
91
+ please refer to the Registration Form of Yi Series Models for Commercial Purposes
92
+ (“Registration Form”), as provided in Attachment 1 of the Yi Series Models
93
+ Commercial License Agreement (available at https://www.lingyiwanwu.com/yi-license)
94
+ and send completed Registration Form to the email: yi@01.ai to complete the
95
+ registration and obtain the license for Commercial Purposes. If you obtained the
96
+ license for Commercial Purposes and use the Yi Series Models and Derivatives for
97
+ Commercial Purposes, you must comply with the afore-mentioned license restrictions
98
+ and restrictions specified under the Yi Series Models Commercial License Agreement.
99
+
100
+
101
+ 3. Intellectual Property
102
+ The ownership of the Yi Series Models and their related intellectual property
103
+ rights is solely held by the Licensor.
104
+
105
+ In any circumstance, without the prior written consent of the Licensor, you are
106
+ not allowed to use any Logo associated with the Licensor. If your use of
107
+ Licensor's Logo in violation of this Agreement causes any losses to the Licensor
108
+ or others, you will bear full legal responsibility.
109
+
110
+
111
+ 4. Disclaimer and Limitation of Liability
112
+
113
+ The Yi Series Models are provided "AS IS." The Licensor does not provide any
114
+ express or implied warranties for the Yi Series Models, including but not
115
+ limited to stability, ownership, merchantability, non-infringement, or fitness
116
+ for a specific purpose of the Yi Series Models and their output results. You
117
+ assume all responsibilities for the risks and consequences arising from the use,
118
+ reproduction, distribution of the Yi Series Models, and the creation of
119
+ Derivatives.
120
+
121
+ The Licensor complies with Laws and Regulations at all stages of model training,
122
+ maintaining the legality, authenticity, accuracy, objectivity, and diversity of
123
+ data and algorithms. The Licensor is not liable for any direct, indirect,
124
+ incidental consequences, and other losses or damages related to your use,
125
+ reproduction, and distribution of the Yi Series Models, and the creation of
126
+ Derivatives under this Agreement. This includes but is not limited to:
127
+
128
+ 1) The Licensor is not responsible for data security risks resulting from your
129
+ use of the Yi Series Models.
130
+
131
+ 2) The Yi Series Models may contain Personal Information. When you use Yi Series
132
+ Models, you acknowledge that you are the data processing entity as defined under
133
+ the Laws and Regulations responsible for determining the processing methods and
134
+ purposes of Personal Information. You must comply with legal requirements for
135
+ processing any Personal Information that may be contained in the Yi Series
136
+ Models and assume the associated legal responsibilities, as well as the risks
137
+ and consequences of processing Personal Information.
138
+
139
+ 3) The Licensor is not liable for reputation risks arising from your use of the
140
+ Yi Series Models or the output results of the Yi Series Models.
141
+
142
+ 4) The Licensor is not liable for intellectual property risks associated with
143
+ your use of the Yi Series Models’ output results.
144
+
145
+ If your use, reproduction, distribution of the Yi Series Models, or the creation
146
+ of Derivatives result in losses to the Licensor, the Licensor has the right to
147
+ seek compensation from you. For any claims made by Third Parties against the
148
+ Licensor related to your use, reproduction, and distribution of the Yi Series
149
+ Models, or the creation of Derivatives, the Licensor has the right to demand
150
+ that you defend, compensate, and indemnify the Licensor and protect the Licensor
151
+ from harm.
152
+
153
+
154
+ 5. Dispute Resolution
155
+
156
+ The stipulation, effectiveness, interpretation, performance, modification, and
157
+ termination of the Agreement, the use, copy and Distribute of the Yi Series
158
+ Models, and dispute resolution associated with your use, copy and distribution
159
+ shall be governed by the laws of the mainland of the People's Republic of China
160
+ (for the purposes of this agreement only, excluding Hong Kong, Macau, and
161
+ Taiwan), and the application of conflict of laws is excluded.
162
+
163
+ Any disputes arising from the use, copy or distribution of the Yi Series Models
164
+ should first be resolved through amicable negotiations. If negotiations fail,
165
+ legal proceedings should be initiated in the People's Court at the location of
166
+ the Licensor.
167
+
168
+
169
+ 6. Effectiveness and Termination of the Agreement
170
+
171
+ Your use of the Yi Series Models signifies that you have read and agreed to be
172
+ bound by the terms of the Agreement. The Agreement becomes effective from the
173
+ date of your use of the Yi Series Models and will terminate from the date you
174
+ cease using the Yi Series Models. If you violate any terms or restrictions in
175
+ the Agreement, the Licensor reserves the right to terminate the Agreement.
176
+
177
+ Upon termination of the Agreement, you must immediately cease using the Yi
178
+ Series Models. Section 4, "Disclaimer and Limitation of Liability," and Section
179
+ 5, "Dispute Resolution," of this Agreement remain in effect after the
180
+ termination of this Agreement.
181
+
182
+
183
+ 7. Updates to the Agreement and Contact Information
184
+
185
+ The Licensor reserves the right to update the Agreement from time to time. The
186
+ latest version of the Agreement will be posted by the Licensor through
187
+ https://01.ai.
188
+
189
+ For any questions related to licensing and copyright, please contact the
190
+ Licensor at yi@01.ai.
191
+
192
+
193
+
194
+ Yi系列模型社区许可协议
195
+ 版本: 2.1
196
+ 发布日期: 2023年11月23日
197
+
198
+ 1. 定义
199
+
200
+ “协议”是指本协议中定义Yi系列模型使用、复制和分发的条款和条件。
201
+
202
+ “模型”是指任何附带的基于机器学习的组件(包括检查点),包括学习的权重、参数(包括优
203
+ 化器状态)。
204
+
205
+ “Yi系列模型”是指许可方开源的以Yi命名的不同规格、不同能力的模型,包括
206
+ Yi-6B、Yi-34B等。
207
+
208
+ “模型衍生品”是指对Yi系列模型的所有修改、基于Yi系列模型的工作,或通过将Yi系列模型
209
+ 的权重、参数、激活或输出模式转移到其他模型而创建或初始化的任何其他模型,以使其他
210
+ 模型的性能与Yi系列模型类似,包括但不限于需要使用中间数据表示的提取方法或基于Yi系
211
+ 列模型生成合成数据来训练其他模型的方法。
212
+
213
+ “许可方”是指北京零一万物信息技术有限公司。
214
+
215
+ “您”是指行使本协议授予的权限和/或出于任何目的和在任何使用领域使用Yi系列模型的个
216
+ 人或法人实体。
217
+
218
+ “第三方”是指您之外的任何个人、法人实体或非法人组织。
219
+
220
+ “分发”是指向第三方传输、复制、发布或以其他方式共享Yi系列模型,包括将Yi系列模型作
221
+ 为通过电子或其他远程方式(例如基于 API 或 Web 访问的任何 SaaS 软件或 PaaS 软
222
+ 件)提供。
223
+
224
+ “商业用途”是指使用Yi系列模型,直接或间接为实体或个人进行运营、推广或产生收入,或
225
+ 用于任何其他盈利目的。
226
+
227
+ “法律法规”是指中华人民共和国大陆地区(仅为本协议之目的,不包括香港、澳门和台湾)
228
+ 的法律及行政法规。
229
+
230
+ “个人信息”是指以电子或者其他方式记录的与已识别或者可识别的自然人有关的各种信息,
231
+ 不包括匿名化处理后的信息。
232
+
233
+ “标识” 是指任何商标、服务标记、商号、域名、网站名称或其他带有显著品牌特征的标记。
234
+
235
+
236
+ 2. 许可及许可限制
237
+
238
+ 许可方特此授予您非排他性、全球性、不可转让、不可再许可、可撤销、免版税的版权许可。
239
+ 您必须满足如下许可限制条件:
240
+
241
+ 1) 您对Yi系列模型的使用应遵守法律法规以及其他国家/地区适用的法律要求、尊重社会公
242
+ 德和伦理道德。包括但不限于您不得将Yi系列模型用作危害国家安全、宣扬恐怖主义、极端
243
+ 主义,宣扬民族及种族仇恨、歧视,暴力、色情,以及虚假有害信息等法律法规以及其他国
244
+ 家/地区适用的法律要求禁止的目的。
245
+
246
+ 2) 您不得出于军事或非法目的,或以法律法规以及其他国家/地区适用的法律要求所不允许
247
+ 的方式 a) 使用、复制、或分发Yi系列模型; 或 b) 创建Yi系列模型的全部或部分衍生品。
248
+
249
+ 3) 您对Yi系列模型的使用(包括使用Yi系列模型的输出)以及模型衍生品的创建不得侵犯
250
+ 任何第三方的合法权益,包括但不限于他人肖像权、名誉权、隐私权等人格权,著作权、专
251
+ 利权、商业秘密等知识产权,或其他财产权益。
252
+
253
+ 4) 您必须向Yi系列模型及Yi系列模型衍生品的任何第三方使用者明确Yi系列模型的来源为
254
+ 许可方并向其提供本协议的副本。
255
+
256
+ 5) 若您修改Yi系列模型得到模型衍生品,您必须以显著的方式说明修改的内容,且上述修
257
+ 改不得违反本协议的许可限制条件,也不能允许、协助或以其他方式使得第三方违反本协议
258
+ 中的许可限制条件。
259
+
260
+ 如果您计划将Yi系列模型及模型衍生品用作商业用途,请参见《Yi系列模型商用许可协议》
261
+ (参见:https://www.lingyiwanwu.com/yi-license)附件一《Yi系列模型商用登
262
+ 记表》(“登记表”)并将填写完毕的登记表发送至 yi@01.ai 邮箱完成登记即可获得商用
263
+ 许可。若您获得商用许可并将Yi系列模型及模型衍生品用作商业用途,您应满足许可方上述
264
+ 许可限制条件及《Yi系列模型商用许可协议》中的商业许可限制。
265
+
266
+ 3. 知识产权
267
+
268
+ Yi系列模型的所有权及其相关知识产权,由许可方单独所有。
269
+
270
+ 在任何情况下,未经许可方事先书面同意,您不得以任何方式使用许可方的任何标识。由于
271
+ 您违反本协议使用许可方的标识给许可方或他人造成损失的,由您承担全部法律责任。
272
+
273
+
274
+ 4. 免责声明及责任限制
275
+
276
+ Yi系列模型按“原样”提供。许可方不对Yi系列模型提供任何明示或暗示的保证,包括但不限
277
+ 于:模型及输出结果的稳定性、所有权、适销性、非侵权性、或特定用途适用性。您将对适
278
+ 用、复制及分发Yi系列模型以及创建模型衍生品所产生的风险与后果承担所有责任。
279
+
280
+ 许可方在模型训练的所有阶段都遵守法律法规,坚持维护数据和算法的合法、真实、准确、
281
+ 客观和多样性。许可方不对您根据本协议使用、复制及分发Yi系列模型,以及创建模��衍生
282
+ 品而产生或与之相关的任何直接、间接、附带的后果、以及其他损失或损害承担责任。包括
283
+ 但不限于:
284
+
285
+ 1) 许可方不承担您因使用Yi系列模型而导致的数据安全风险。
286
+
287
+ 2) Yi系列模型中可能包含个人信息。在您使用Yi系列模型的过程中,您承认您为法律法规
288
+ 定义下决定个人信息处理方式和目的的个人信息处理者。您应遵守法律法规要求处理Yi系列
289
+ 模型中可能包含的个人信息,并承担相应的法律责任,以及处理个人信息的风险和后果。
290
+
291
+ 3) 许可方不承担您使用Yi系列模型或模型输出结果而产生的声誉风险。
292
+
293
+ 4) 许可方不承担您使用Yi系列模型的输出结果涉及的知识产权风险。
294
+
295
+ 若由于您对Yi系列模型的使用、复制或分发,或者创建模型衍生品而导致许可方遭受损失,
296
+ 许可方有权要求您对许可方的损失进行赔偿。对于任何第三方向许可方提出的因您使用、复
297
+ 制或分发Yi系列模型或创建模型衍生品行为的相关索赔,许可方有权要求您为许可方进行辩
298
+ 护、赔偿并使许可方免受损害。
299
+
300
+
301
+ 5. 争议解决
302
+
303
+ 协议的订立、效力、解释、履行、修改和终止,使用、复制和分发Yi系列模型以及争议解决
304
+ 均适用中华人民共和国大陆地区(仅为本协议之目的,不包括香港、澳门和台湾)法律,并
305
+ 排除冲突法的适用。
306
+
307
+ 因使用、复制和分发Yi系列模型而发生的任何争议,各方应首先通过友好协商的方式加以解
308
+ 决。协商不成时,应向许可方所在地人民法院提起诉讼。
309
+
310
+
311
+ 6. 协议的生效及终止
312
+
313
+ 您使用Yi系列模型即表示您已阅读并同意接受协议的约束。协议自您使用Yi系列模型之日起
314
+ 生效并将在您停止使用Yi系列模型之日起终止。若您违反协议中的任何条款或限制,许可方
315
+ 有权终止协议。
316
+
317
+ 若协议终止,您需立即停止使用Yi系列模型。本协议第4条“免责声明及责任限制”及第5条
318
+ “争议解决”在协议终止后仍有效。
319
+
320
+
321
+ 7. 协议更新及联系方式
322
+
323
+ 许可方有权对协议进行不时更新。许可方将通过 https://01.ai 公布协议最新版本。有关
324
+ 许可和版权的任何问题,请通过 yi@01.ai 与许可方联系。
README.md ADDED
@@ -0,0 +1,252 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ license_name: yi-license
4
+ license_link: LICENSE
5
+ ---
6
+
7
+ <div align="center">
8
+
9
+ <picture>
10
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/01-ai/Yi/main/assets/img/Yi_logo_icon_dark.svg" width="200px">
11
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/01-ai/Yi/main/assets/img/Yi_logo_icon_light.svg" width="200px">
12
+ <img alt="specify theme context for images" src="https://raw.githubusercontent.com/01-ai/Yi/main/assets/img/Yi_logo_icon_light.svg" width="200px">
13
+ </picture>
14
+
15
+ </div>
16
+
17
+ <div align="center">
18
+ <h1 align="center">Yi Vision Language Model</h1>
19
+ </div>
20
+
21
+
22
+ <div align="center">
23
+ <h3 align="center">Better Bilingual Multimodal Model</h3>
24
+ </div>
25
+
26
+ <p align="center">
27
+ 🤗 <a href="https://huggingface.co/01-ai" target="_blank">Hugging Face</a> • 🤖 <a href="https://www.modelscope.cn/organization/01ai/" target="_blank">ModelScope</a> • ✡️ <a href="https://wisemodel.cn/organization/01.AI" target="_blank">WiseModel</a>
28
+ </p>
29
+
30
+ <p align="center">
31
+ 👩‍🚀 Ask questions or discuss ideas on <a href="https://github.com/01-ai/Yi/discussions" target="_blank"> GitHub </a>!
32
+ </p>
33
+
34
+ <p align="center">
35
+ 👋 Join us 💬 <a href="https://github.com/01-ai/Yi/issues/43#issuecomment-1827285245" target="_blank"> WeChat (Chinese) </a>!
36
+ </p>
37
+
38
+ <p align="center">
39
+ 📚 Grow at <a href="https://github.com/01-ai/Yi/blob/main/docs/learning_hub.md"> Yi Learning Hub </a>!
40
+ </p>
41
+
42
+ <hr>
43
+
44
+ <!-- DO NOT REMOVE ME -->
45
+
46
+ <details open>
47
+ <summary></b>📕 Table of Contents</b></summary>
48
+
49
+ - [What is Yi-VL?](#what-is-yi-vl)
50
+ - [Overview](#overview)
51
+ - [Models](#models)
52
+ - [Features](#features)
53
+ - [Architecture](#architecture)
54
+ - [Training](#training)
55
+ - [Limitations](#limitations)
56
+ - [Why Yi-VL?](#why-yi-vl)
57
+ - [Benchmarks](#benchmarks)
58
+ - [Showcases](#showcases)
59
+ - [How to use Yi-VL?](#how-to-use-yi-vl)
60
+ - [Quick start](#quick-start)
61
+ - [Hardware requirements](#hardware-requirements)
62
+ - [Misc.](#misc)
63
+ - [Acknowledgements and attributions](#acknowledgements-and-attributions)
64
+ - [List of used open-source projects](#list-of-used-open-source-projects)
65
+ - [License](#license)
66
+
67
+ </details>
68
+
69
+ <hr>
70
+
71
+ # What is Yi-VL?
72
+
73
+ ## Overview
74
+
75
+ - **Yi Visual Language (Yi-VL)** model is the open-source, multimodal version of the Yi **Large Language Model (LLM)** series, enabling content comprehension, recognition, and multi-round conversations about images.
76
+
77
+ - Yi-VL demonstrates exceptional performance, **ranking first** among all existing open-source models in the latest benchmarks including [MMMU](https://mmmu-benchmark.github.io/#leaderboard) in English and [CMMMU](https://mmmu-benchmark.github.io/#leaderboard) in Chinese (based on data available up to January 2024).
78
+
79
+ - Yi-VL-34B is the **first** open-source 34B vision language model worldwide.
80
+
81
+ ## Models
82
+
83
+ Yi-VL has released the following versions.
84
+
85
+ Model | Download
86
+ |---|---
87
+ Yi-VL-34B |• [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-VL-34B) • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-VL-34B/summary)
88
+ Yi-VL-6B | • [🤗 Hugging Face](https://huggingface.co/01-ai/Yi-VL-6B) • [🤖 ModelScope](https://www.modelscope.cn/models/01ai/Yi-VL-6B/summary)
89
+
90
+ ## Features
91
+
92
+ Yi-VL offers the following features:
93
+
94
+ - Multi-round text-image conversations: Yi-VL can take both text and images as inputs and produce text outputs. Currently, it supports multi-round visual question answering with one image.
95
+
96
+ - Bilingual text support: Yi-VL supports conversations in both English and Chinese, including text recognition in images.
97
+
98
+ - Strong image comprehension: Yi-VL is adept at analyzing visuals, making it an efficient tool for tasks like extracting, organizing, and summarizing information from images.
99
+
100
+ - Fine-grained image resolution: Yi-VL supports image understanding at a higher resolution of 448&times;448.
101
+
102
+ ## Architecture
103
+
104
+ Yi-VL adopts the [LLaVA](https://github.com/haotian-liu/LLaVA) architecture, which is composed of three primary components:
105
+
106
+ - Vision Transformer (ViT): it's initialized with [CLIP ViT-H/14 model](https://huggingface.co/laion/CLIP-ViT-H-14-laion2B-s32B-b79K) and used for image encoding.
107
+
108
+ - Projection Module: it's designed to align image features with text feature space, consisting of a two-layer Multilayer Perceptron (MLP) with layer normalizations.
109
+
110
+ - Large Language Model (LLM): it's initialized with [Yi-34B-Chat](https://huggingface.co/01-ai/Yi-34B-Chat) or [Yi-6B-Chat](https://huggingface.co/01-ai/Yi-6B-Chat), demonstrating exceptional proficiency in understanding and generating both English and Chinese.
111
+
112
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/656d9adce8bf55919aca7c3f/EGVHSWG4kAcX01xDaoeXS.png)
113
+
114
+ ## Training
115
+
116
+ ### Training process
117
+
118
+ Yi-VL is trained to align visual information well to the semantic space of Yi LLM, which undergoes a comprehensive three-stage training process:
119
+
120
+ - Stage 1: The parameters of ViT and the projection module are trained using an image resolution of 224&times;224. The LLM weights are frozen. The training leverages an image caption dataset comprising 100 million image-text pairs from [LAION-400M](https://laion.ai/blog/laion-400-open-dataset/). The primary objective is to enhance the ViT's knowledge acquisition within our specified architecture and to achieve better alignment between the ViT and the LLM.
121
+
122
+ - Stage 2: The image resolution of ViT is scaled up to 448&times;448, and the parameters of ViT and the projection module are trained. It aims to further boost the model's capability for discerning intricate visual details. The dataset used in this stage includes about 25 million image-text pairs, such as [LAION-400M](https://laion.ai/blog/laion-400-open-dataset/), [CLLaVA](https://huggingface.co/datasets/LinkSoul/Chinese-LLaVA-Vision-Instructions), [LLaVAR](https://llavar.github.io/), [Flickr](https://www.kaggle.com/datasets/hsankesara/flickr-image-dataset), [VQAv2](https://paperswithcode.com/dataset/visual-question-answering-v2-0), [RefCOCO](https://github.com/lichengunc/refer/tree/master), [Visual7w](http://ai.stanford.edu/~yukez/visual7w/) and so on.
123
+
124
+ - Stage 3: The parameters of the entire model (that is, ViT, projection module, and LLM) are trained. The primary goal is to enhance the model's proficiency in multimodal chat interactions, thereby endowing it with the ability to seamlessly integrate and interpret visual and linguistic inputs. To this end, the training dataset encompasses a diverse range of sources, totalling approximately 1 million image-text pairs, including [GQA](https://cs.stanford.edu/people/dorarad/gqa/download.html), [VizWiz VQA](https://vizwiz.org/tasks-and-datasets/vqa/), [TextCaps](https://opendatalab.com/OpenDataLab/TextCaps), [OCR-VQA](https://ocr-vqa.github.io/), [Visual Genome](https://homes.cs.washington.edu/~ranjay/visualgenome/api.html), [LAION GPT4V](https://huggingface.co/datasets/laion/gpt4v-dataset) and so on. To ensure data balancing, we impose a cap on the maximum data contribution from any single source, restricting it to no more than 50,000 pairs.
125
+
126
+ Below are the parameters configured for each stage.
127
+
128
+ Stage | Global batch size | Learning rate | Gradient clip | Epochs
129
+ |---|---|---|---|---
130
+ Stage 1, 2 |4096|1e-4|0.5|1
131
+ Stage 3|256|2e-5|1.0|2
132
+
133
+ ### Training resource consumption
134
+
135
+ - The training consumes 128 NVIDIA A800 (80G) GPUs.
136
+
137
+ - The total training time amounted to approximately 10 days for Yi-VL-34B and 3 days for Yi-VL-6B.
138
+
139
+ ## Limitations
140
+
141
+ This is the initial release of the Yi-VL, which comes with some known limitations. It is recommended to carefully evaluate potential risks before adopting any models.
142
+
143
+ - Feature limitation
144
+
145
+ - Visual question answering is supported. Other features like text-to-3D and image-to-video are not yet supported.
146
+
147
+ - A single image rather than several images can be accepted as an input.
148
+
149
+ - Hallucination problem
150
+
151
+ - There is a certain possibility of generating content that does not exist in the image.
152
+
153
+ - In scenes containing multiple objects, some objects might be incorrectly identified or described with insufficient detail.
154
+
155
+ - Resolution issue
156
+
157
+ - Yi-VL is trained on images with a resolution of 448&times;448. During inference, inputs of any resolution are resized to 448&times;448. Low-resolution images may result in information loss, and more fine-grained images (above 448) do not bring in extra knowledge.
158
+
159
+ - Other limitations of the Yi LLM.
160
+
161
+ # Why Yi-VL?
162
+
163
+ ## Benchmarks
164
+
165
+ Yi-VL outperforms all existing open-source models in [MMMU](https://mmmu-benchmark.github.io) and [CMMMU](https://cmmmu-benchmark.github.io), two advanced benchmarks that include massive multi-discipline multimodal questions (based on data available up to January 2024).
166
+
167
+ - MMMU
168
+
169
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/656d9adce8bf55919aca7c3f/kCmXuwLbLvequ93kjh3mg.png)
170
+
171
+ - CMMMU
172
+
173
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/656d9adce8bf55919aca7c3f/6YuSakMCg3D2AozixdoZ0.png)
174
+
175
+ ## Showcases
176
+
177
+ Below are some representative examples of detailed description and visual question answering, showcasing the capabilities of Yi-VL.
178
+
179
+ - English
180
+
181
+
182
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/64cc65d786d8dc0caa6ab3cd/F_2bIVwMtVamygbVqtb8E.png)
183
+
184
+ - Chinese
185
+
186
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/656d9adce8bf55919aca7c3f/l_tLzugFtHk1dkVsFJE7B.png)
187
+
188
+ # How to use Yi-VL?
189
+
190
+ ## Quick start
191
+
192
+ You can perform inference using the code from [LLaVA](https://github.com/haotian-liu/LLaVA). For detailed steps, see [simple startup for pretraining](https://github.com/haotian-liu/LLaVA/pull/966).
193
+
194
+ Notes:
195
+
196
+ - You need to modify the system prompt as follows.
197
+
198
+ ```
199
+ This is a chat between an inquisitive human and an AI assistant. Assume the role of the AI assistant. Read all the images carefully, and respond to the human's questions with informative, helpful, detailed and polite answers. 这是一个好奇的人类和一个人工智能助手之间的对话。假设你扮演这个AI助手的角色。仔细阅读所有的图像,并对人类的问题做出信息丰富、有帮助、详细的和礼貌的回答。
200
+
201
+ ### Human: <image_placeholder>
202
+ What is it in the image?
203
+ ### Assistant:
204
+ ```
205
+
206
+ - You need to set the parameter `mm_vision_tower` in `config.json` to the local ViT path.
207
+
208
+ ## Hardware requirements
209
+
210
+ For model inference, the recommended GPU examples are:
211
+
212
+ - Yi-VL-6B: RTX 3090, RTX 4090, A10, A30
213
+
214
+ - Yi-VL-34B: 4 &times; RTX 4090, A800 (80 GB)
215
+
216
+ # Misc.
217
+
218
+ ## Acknowledgements and attributions
219
+
220
+ This project makes use of open-source software/components. We acknowledge and are grateful to these developers for their contributions to the open-source community.
221
+
222
+ ### List of used open-source projects
223
+
224
+ 1. LLaVA
225
+ - Authors: Haotian Liu, Chunyuan Li, Qingyang Wu, Yuheng Li, and Yong Jae Lee
226
+ - Source: https://github.com/haotian-liu/LLaVA
227
+ - License: Apache-2.0 license
228
+ - Description: The codebase is based on LLaVA code.
229
+
230
+ 2. OpenClip
231
+ - Authors: Gabriel Ilharco, Mitchell Wortsman, Ross Wightman, Cade Gordon, Nicholas Carlini, Rohan Taori, Achal Dave, Vaishaal Shankar, Hongseok Namkoong, John Miller, Hannaneh Hajishirzi, Ali Farhadi, and Ludwig Schmidt
232
+ - Source: https://huggingface.co/laion/CLIP-ViT-H-14-laion2B-s32B-b79K
233
+ - License: MIT
234
+ - Description: The ViT is initialized using the weights of OpenClip.
235
+
236
+ **Notes**
237
+
238
+ - This attribution does not claim to cover all open-source components used. Please check individual components and their respective licenses for full details.
239
+
240
+ - The use of the open-source components is subject to the terms and conditions of the respective licenses.
241
+
242
+ We appreciate the open-source community for their invaluable contributions to the technology world.
243
+
244
+ ## License
245
+
246
+ Please refer to the [acknowledgments and attributions](#acknowledgments_and_attributions) as well as individual components, for the license of source code.
247
+
248
+ The Yi series models are fully open for academic research and free for commercial use, permissions of which are automatically granted upon application.
249
+
250
+ All usage must adhere to the [Yi Series Models Community License Agreement 2.1](https://huggingface.co/01-ai/Yi-VL-34B/blob/main/LICENSE).
251
+
252
+ For free commercial use, you only need to send an email to get official commercial permission.
added_tokens.json ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "<unk>": 0,
3
+ "<|endoftext|>": 2,
4
+ "<|im_end|>": 7,
5
+ "<|im_sep|>": 8,
6
+ "<|im_start|>": 6,
7
+ "<|startoftext|>": 1
8
+ }
config.json ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "./yi-vl-34b",
3
+ "architectures": [
4
+ "LlavaLlamaForCausalLM"
5
+ ],
6
+ "attention_bias": false,
7
+ "bos_token_id": 1,
8
+ "eos_token_id": 2,
9
+ "freeze_mm_mlp_adapter": false,
10
+ "hidden_act": "silu",
11
+ "hidden_size": 7168,
12
+ "image_aspect_ratio": "pad",
13
+ "image_grid_pinpoints": null,
14
+ "initializer_range": 0.02,
15
+ "intermediate_size": 20480,
16
+ "max_position_embeddings": 4096,
17
+ "mm_hidden_size": 1280,
18
+ "mm_projector_type": "mlp2x_gelu_Norm",
19
+ "mm_use_im_patch_token": false,
20
+ "mm_use_im_start_end": false,
21
+ "mm_vision_select_feature": "patch",
22
+ "mm_vision_select_layer": -2,
23
+ "mm_vision_tower": "./vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448",
24
+ "model_type": "llava",
25
+ "moe_layer": null,
26
+ "moe_mode": "easy",
27
+ "num_attention_heads": 56,
28
+ "num_hidden_layers": 60,
29
+ "num_key_value_heads": 8,
30
+ "pretraining_tp": 1,
31
+ "rms_norm_eps": 1e-05,
32
+ "rope_scaling": null,
33
+ "rope_theta": 5000000.0,
34
+ "tie_word_embeddings": false,
35
+ "torch_dtype": "bfloat16",
36
+ "transformers_version": "4.34.0",
37
+ "tune_mm_mlp_adapter": false,
38
+ "tune_vision_tower": true,
39
+ "use_cache": false,
40
+ "use_mm_proj": true,
41
+ "vocab_size": 64000
42
+ }
generation_config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "bos_token_id": 1,
3
+ "do_sample": true,
4
+ "eos_token_id": 2,
5
+ "max_length": 4096,
6
+ "pad_token_id": 0,
7
+ "temperature": 0.6,
8
+ "top_p": 0.8,
9
+ "transformers_version": "4.34.0"
10
+ }
model-00001-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:6a893651bcb354668dee31976e42d56016cdf5a1d4c577d17ad6deed0da32eab
3
+ size 9975341688
model-00002-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:f22ce5c15ee259410749aa1fd01ac3a7e8aaa783c6be27c6a0d1498d290e2ff9
3
+ size 9909310352
model-00003-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:9992f546074070f3e082ac95e2f3df50388f13ea4c484740b45ce2ee09cd938c
3
+ size 9747800992
model-00004-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:6522bcf38a2c15948211277954c4a8259afb46a8d9133d2c22807d2db5c41a64
3
+ size 9747829904
model-00005-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:71e33b7e1b223a9e9d17ffaeeab9d27b84310fb5746bf48a2c53a63e1dea542c
3
+ size 9747829904
model-00006-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:2c83ca377dee0b8d95fdb6270eb6b212318e6ee9ca9012a5030810a58535db13
3
+ size 9938670728
model-00007-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:2da08bd662d6a0be214d18c457fbe99a2703992f581a3079e13715416584c61b
3
+ size 9991593968
model-00008-of-00008.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:1bc2e233fe71bbbecab2893e6292888c6fda14c26b88cab3471d8895af6121ee
3
+ size 1104297512
model.safetensors.index.json ADDED
The diff for this file is too large to render. See raw diff
 
special_tokens_map.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "additional_special_tokens": [
3
+ "<unk>",
4
+ "<|startoftext|>",
5
+ "<|endoftext|>",
6
+ "<|im_start|>",
7
+ "<|im_end|>",
8
+ "<|im_sep|>"
9
+ ],
10
+ "bos_token": "<|startoftext|>",
11
+ "eos_token": "<|endoftext|>",
12
+ "pad_token": "<unk>",
13
+ "unk_token": "<unk>"
14
+ }
tokenizer.model ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:386c49cf943d71aa110361135338c50e38beeff0a66593480421f37b319e1a39
3
+ size 1033105
tokenizer_config.json ADDED
@@ -0,0 +1,76 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "add_bos_token": false,
3
+ "add_eos_token": false,
4
+ "added_tokens_decoder": {
5
+ "0": {
6
+ "content": "<unk>",
7
+ "lstrip": false,
8
+ "normalized": false,
9
+ "rstrip": false,
10
+ "single_word": false,
11
+ "special": true
12
+ },
13
+ "1": {
14
+ "content": "<|startoftext|>",
15
+ "lstrip": false,
16
+ "normalized": false,
17
+ "rstrip": false,
18
+ "single_word": false,
19
+ "special": true
20
+ },
21
+ "2": {
22
+ "content": "<|endoftext|>",
23
+ "lstrip": false,
24
+ "normalized": false,
25
+ "rstrip": false,
26
+ "single_word": false,
27
+ "special": true
28
+ },
29
+ "6": {
30
+ "content": "<|im_start|>",
31
+ "lstrip": false,
32
+ "normalized": false,
33
+ "rstrip": false,
34
+ "single_word": false,
35
+ "special": true
36
+ },
37
+ "7": {
38
+ "content": "<|im_end|>",
39
+ "lstrip": false,
40
+ "normalized": false,
41
+ "rstrip": false,
42
+ "single_word": false,
43
+ "special": true
44
+ },
45
+ "8": {
46
+ "content": "<|im_sep|>",
47
+ "lstrip": false,
48
+ "normalized": false,
49
+ "rstrip": false,
50
+ "single_word": false,
51
+ "special": true
52
+ }
53
+ },
54
+ "additional_special_tokens": [
55
+ "<unk>",
56
+ "<|startoftext|>",
57
+ "<|endoftext|>",
58
+ "<|im_start|>",
59
+ "<|im_end|>",
60
+ "<|im_sep|>"
61
+ ],
62
+ "bos_token": "<|startoftext|>",
63
+ "chat_template": "{% if not add_generation_prompt is defined %}{% set add_generation_prompt = false %}{% endif %}{% for message in messages %}{{'<|im_start|>' + message['role'] + '\n' + message['content'] + '<|im_end|>' + '\n'}}{% endfor %}{% if add_generation_prompt %}{{ '<|im_start|>assistant\n' }}{% endif %}",
64
+ "clean_up_tokenization_spaces": false,
65
+ "eos_token": "<|endoftext|>",
66
+ "legacy": true,
67
+ "model_max_length": 4096,
68
+ "pad_token": "<unk>",
69
+ "padding_side": "right",
70
+ "sp_model_kwargs": {},
71
+ "spaces_between_special_tokens": false,
72
+ "tokenizer_class": "LlamaTokenizer",
73
+ "tokenizer_file": null,
74
+ "unk_token": "<unk>",
75
+ "use_default_system_prompt": true
76
+ }
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/.gitattributes ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.bin filter=lfs diff=lfs merge=lfs -text
4
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
5
+ *.ftz filter=lfs diff=lfs merge=lfs -text
6
+ *.gz filter=lfs diff=lfs merge=lfs -text
7
+ *.h5 filter=lfs diff=lfs merge=lfs -text
8
+ *.joblib filter=lfs diff=lfs merge=lfs -text
9
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
10
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
11
+ *.model filter=lfs diff=lfs merge=lfs -text
12
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
13
+ *.npy filter=lfs diff=lfs merge=lfs -text
14
+ *.npz filter=lfs diff=lfs merge=lfs -text
15
+ *.onnx filter=lfs diff=lfs merge=lfs -text
16
+ *.ot filter=lfs diff=lfs merge=lfs -text
17
+ *.parquet filter=lfs diff=lfs merge=lfs -text
18
+ *.pb filter=lfs diff=lfs merge=lfs -text
19
+ *.pickle filter=lfs diff=lfs merge=lfs -text
20
+ *.pkl filter=lfs diff=lfs merge=lfs -text
21
+ *.pt filter=lfs diff=lfs merge=lfs -text
22
+ *.pth filter=lfs diff=lfs merge=lfs -text
23
+ *.rar filter=lfs diff=lfs merge=lfs -text
24
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
25
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
26
+ *.tflite filter=lfs diff=lfs merge=lfs -text
27
+ *.tgz filter=lfs diff=lfs merge=lfs -text
28
+ *.wasm filter=lfs diff=lfs merge=lfs -text
29
+ *.xz filter=lfs diff=lfs merge=lfs -text
30
+ *.zip filter=lfs diff=lfs merge=lfs -text
31
+ *.zst filter=lfs diff=lfs merge=lfs -text
32
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/README.md ADDED
@@ -0,0 +1,165 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ widget:
4
+ - src: >-
5
+ https://huggingface.co/datasets/mishig/sample_images/resolve/main/cat-dog-music.png
6
+ candidate_labels: playing music, playing sports
7
+ example_title: Cat & Dog
8
+ library_name: open_clip
9
+ pipeline_tag: zero-shot-image-classification
10
+ ---
11
+ # Model Card for CLIP ViT-H/14 - LAION-2B
12
+
13
+ # Table of Contents
14
+
15
+ 1. [Model Details](#model-details)
16
+ 2. [Uses](#uses)
17
+ 3. [Training Details](#training-details)
18
+ 4. [Evaluation](#evaluation)
19
+ 5. [Acknowledgements](#acknowledgements)
20
+ 6. [Citation](#citation)
21
+ 7. [How To Get Started With the Model](#how-to-get-started-with-the-model)
22
+
23
+
24
+ # Model Details
25
+
26
+ ## Model Description
27
+
28
+ A CLIP ViT-H/14 model trained with the LAION-2B English subset of LAION-5B (https://laion.ai/blog/laion-5b/) using OpenCLIP (https://github.com/mlfoundations/open_clip).
29
+
30
+ Model training done by Romain Beaumont on the [stability.ai](https://stability.ai/) cluster.
31
+
32
+ # Uses
33
+
34
+ As per the original [OpenAI CLIP model card](https://github.com/openai/CLIP/blob/d50d76daa670286dd6cacf3bcd80b5e4823fc8e1/model-card.md), this model is intended as a research output for research communities. We hope that this model will enable researchers to better understand and explore zero-shot, arbitrary image classification. We also hope it can be used for interdisciplinary studies of the potential impact of such model.
35
+
36
+ The OpenAI CLIP paper includes a discussion of potential downstream impacts to provide an example for this sort of analysis. Additionally, the LAION-5B blog (https://laion.ai/blog/laion-5b/) and upcoming paper include additional discussion as it relates specifically to the training dataset.
37
+
38
+ ## Direct Use
39
+
40
+ Zero-shot image classification, image and text retrieval, among others.
41
+
42
+ ## Downstream Use
43
+
44
+ Image classification and other image task fine-tuning, linear probe image classification, image generation guiding and conditioning, among others.
45
+
46
+ ## Out-of-Scope Use
47
+
48
+ As per the OpenAI models,
49
+
50
+ **Any** deployed use case of the model - whether commercial or not - is currently out of scope. Non-deployed use cases such as image search in a constrained environment, are also not recommended unless there is thorough in-domain testing of the model with a specific, fixed class taxonomy. This is because our safety assessment demonstrated a high need for task specific testing especially given the variability of CLIP’s performance with different class taxonomies. This makes untested and unconstrained deployment of the model in any use case currently potentially harmful.
51
+
52
+ Certain use cases which would fall under the domain of surveillance and facial recognition are always out-of-scope regardless of performance of the model. This is because the use of artificial intelligence for tasks such as these can be premature currently given the lack of testing norms and checks to ensure its fair use.
53
+
54
+ Since the model has not been purposefully trained in or evaluated on any languages other than English, its use should be limited to English language use cases.
55
+
56
+ Further the above notice, the LAION-5B dataset used in training of these models has additional considerations, see below.
57
+
58
+ # Training Details
59
+
60
+ ## Training Data
61
+
62
+ This model was trained with the 2 Billion sample English subset of LAION-5B (https://laion.ai/blog/laion-5b/).
63
+
64
+ **IMPORTANT NOTE:** The motivation behind dataset creation is to democratize research and experimentation around large-scale multi-modal model training and handling of uncurated, large-scale datasets crawled from publically available internet. Our recommendation is therefore to use the dataset for research purposes. Be aware that this large-scale dataset is uncurated. Keep in mind that the uncurated nature of the dataset means that collected links may lead to strongly discomforting and disturbing content for a human viewer. Therefore, please use the demo links with caution and at your own risk. It is possible to extract a “safe” subset by filtering out samples based on the safety tags (using a customized trained NSFW classifier that we built). While this strongly reduces the chance for encountering potentially harmful content when viewing, we cannot entirely exclude the possibility for harmful content being still present in safe mode, so that the warning holds also there. We think that providing the dataset openly to broad research and other interested communities will allow for transparent investigation of benefits that come along with training large-scale models as well as pitfalls and dangers that may stay unreported or unnoticed when working with closed large datasets that remain restricted to a small community. Providing our dataset openly, we however do not recommend using it for creating ready-to-go industrial products, as the basic research about general properties and safety of such large-scale models, which we would like to encourage with this release, is still in progress.
65
+
66
+ ## Training Procedure
67
+
68
+ Please see [training notes](https://docs.google.com/document/d/1EFbMLRWSSV0LUf9Du1pWzWqgeiIRPwEWX2s1C6mAk5c) and [wandb logs](https://wandb.ai/rom1504/eval_openclip/reports/H-14--VmlldzoyNDAxODQ3).
69
+
70
+ # Evaluation
71
+
72
+ Evaluation done with code in the [LAION CLIP Benchmark suite](https://github.com/LAION-AI/CLIP_benchmark).
73
+
74
+ ## Testing Data, Factors & Metrics
75
+
76
+ ### Testing Data
77
+
78
+ The testing is performed with VTAB+ (A combination of VTAB (https://arxiv.org/abs/1910.04867) w/ additional robustness datasets) for classification and COCO and Flickr for retrieval.
79
+
80
+ **TODO** - more detail
81
+
82
+ ## Results
83
+
84
+ The model achieves a 78.0 zero-shot top-1 accuracy on ImageNet-1k.
85
+
86
+ An initial round of benchmarks have been performed on a wider range of datasets, currently viewable at https://github.com/LAION-AI/CLIP_benchmark/blob/main/benchmark/results.ipynb
87
+
88
+ **TODO** - create table for just this model's metrics.
89
+
90
+ # Acknowledgements
91
+
92
+ Acknowledging [stability.ai](https://stability.ai/) for the compute used to train this model.
93
+
94
+ # Citation
95
+
96
+ **BibTeX:**
97
+
98
+ LAION-5B
99
+ ```bibtex
100
+ @inproceedings{schuhmann2022laionb,
101
+ title={{LAION}-5B: An open large-scale dataset for training next generation image-text models},
102
+ author={Christoph Schuhmann and
103
+ Romain Beaumont and
104
+ Richard Vencu and
105
+ Cade W Gordon and
106
+ Ross Wightman and
107
+ Mehdi Cherti and
108
+ Theo Coombes and
109
+ Aarush Katta and
110
+ Clayton Mullis and
111
+ Mitchell Wortsman and
112
+ Patrick Schramowski and
113
+ Srivatsa R Kundurthy and
114
+ Katherine Crowson and
115
+ Ludwig Schmidt and
116
+ Robert Kaczmarczyk and
117
+ Jenia Jitsev},
118
+ booktitle={Thirty-sixth Conference on Neural Information Processing Systems Datasets and Benchmarks Track},
119
+ year={2022},
120
+ url={https://openreview.net/forum?id=M3Y74vmsMcY}
121
+ }
122
+ ```
123
+
124
+ OpenAI CLIP paper
125
+ ```
126
+ @inproceedings{Radford2021LearningTV,
127
+ title={Learning Transferable Visual Models From Natural Language Supervision},
128
+ author={Alec Radford and Jong Wook Kim and Chris Hallacy and A. Ramesh and Gabriel Goh and Sandhini Agarwal and Girish Sastry and Amanda Askell and Pamela Mishkin and Jack Clark and Gretchen Krueger and Ilya Sutskever},
129
+ booktitle={ICML},
130
+ year={2021}
131
+ }
132
+ ```
133
+
134
+ OpenCLIP software
135
+ ```
136
+ @software{ilharco_gabriel_2021_5143773,
137
+ author = {Ilharco, Gabriel and
138
+ Wortsman, Mitchell and
139
+ Wightman, Ross and
140
+ Gordon, Cade and
141
+ Carlini, Nicholas and
142
+ Taori, Rohan and
143
+ Dave, Achal and
144
+ Shankar, Vaishaal and
145
+ Namkoong, Hongseok and
146
+ Miller, John and
147
+ Hajishirzi, Hannaneh and
148
+ Farhadi, Ali and
149
+ Schmidt, Ludwig},
150
+ title = {OpenCLIP},
151
+ month = jul,
152
+ year = 2021,
153
+ note = {If you use this software, please cite it as below.},
154
+ publisher = {Zenodo},
155
+ version = {0.1},
156
+ doi = {10.5281/zenodo.5143773},
157
+ url = {https://doi.org/10.5281/zenodo.5143773}
158
+ }
159
+ ```
160
+
161
+ # How to Get Started with the Model
162
+
163
+ Use the code below to get started with the model.
164
+
165
+ ** TODO ** - Hugging Face transformers, OpenCLIP, and timm getting started snippets
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/config.json ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448",
3
+ "architectures": [
4
+ "CLIPVisionModel"
5
+ ],
6
+ "attention_dropout": 0.0,
7
+ "dropout": 0.0,
8
+ "hidden_act": "gelu",
9
+ "hidden_size": 1280,
10
+ "image_size": 448,
11
+ "initializer_factor": 1.0,
12
+ "initializer_range": 0.02,
13
+ "intermediate_size": 5120,
14
+ "layer_norm_eps": 1e-05,
15
+ "model_type": "clip_vision_model",
16
+ "num_attention_heads": 16,
17
+ "num_channels": 3,
18
+ "num_hidden_layers": 32,
19
+ "patch_size": 14,
20
+ "projection_dim": 1024,
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.34.0"
23
+ }
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/merges.txt ADDED
The diff for this file is too large to render. See raw diff
 
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/open_clip_config.json ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "model_cfg": {
3
+ "embed_dim": 1024,
4
+ "vision_cfg": {
5
+ "image_size": 224,
6
+ "layers": 32,
7
+ "width": 1280,
8
+ "head_width": 80,
9
+ "patch_size": 14
10
+ },
11
+ "text_cfg": {
12
+ "context_length": 77,
13
+ "vocab_size": 49408,
14
+ "width": 1024,
15
+ "heads": 16,
16
+ "layers": 24
17
+ }
18
+ },
19
+ "preprocess_cfg": {
20
+ "mean": [
21
+ 0.48145466,
22
+ 0.4578275,
23
+ 0.40821073
24
+ ],
25
+ "std": [
26
+ 0.26862954,
27
+ 0.26130258,
28
+ 0.27577711
29
+ ]
30
+ }
31
+ }
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/open_clip_pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:9a78ef8e8c73fd0df621682e7a8e8eb36c6916cb3c16b291a082ecd52ab79cc4
3
+ size 3944692325
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/preprocessor_config.json ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "crop_size": 448,
3
+ "do_center_crop": true,
4
+ "do_normalize": true,
5
+ "do_resize": true,
6
+ "feature_extractor_type": "CLIPFeatureExtractor",
7
+ "image_mean": [
8
+ 0.48145466,
9
+ 0.4578275,
10
+ 0.40821073
11
+ ],
12
+ "image_std": [
13
+ 0.26862954,
14
+ 0.26130258,
15
+ 0.27577711
16
+ ],
17
+ "resample": 3,
18
+ "size": 448
19
+ }
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:fa0c1b4a16fa93bd8bb53e5190e8624dc6f5de5175b9c6ebf02cc5c545247e6a
3
+ size 2527168934
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/special_tokens_map.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"bos_token": {"content": "<|startoftext|>", "single_word": false, "lstrip": false, "rstrip": false, "normalized": true}, "eos_token": {"content": "<|endoftext|>", "single_word": false, "lstrip": false, "rstrip": false, "normalized": true}, "unk_token": {"content": "<|endoftext|>", "single_word": false, "lstrip": false, "rstrip": false, "normalized": true}, "pad_token": "<|endoftext|>"}
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/tokenizer.json ADDED
The diff for this file is too large to render. See raw diff
 
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/tokenizer_config.json ADDED
@@ -0,0 +1,34 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "unk_token": {
3
+ "content": "<|endoftext|>",
4
+ "single_word": false,
5
+ "lstrip": false,
6
+ "rstrip": false,
7
+ "normalized": true,
8
+ "__type": "AddedToken"
9
+ },
10
+ "bos_token": {
11
+ "content": "<|startoftext|>",
12
+ "single_word": false,
13
+ "lstrip": false,
14
+ "rstrip": false,
15
+ "normalized": true,
16
+ "__type": "AddedToken"
17
+ },
18
+ "eos_token": {
19
+ "content": "<|endoftext|>",
20
+ "single_word": false,
21
+ "lstrip": false,
22
+ "rstrip": false,
23
+ "normalized": true,
24
+ "__type": "AddedToken"
25
+ },
26
+ "pad_token": "<|endoftext|>",
27
+ "add_prefix_space": false,
28
+ "errors": "replace",
29
+ "do_lower_case": true,
30
+ "name_or_path": "openai/clip-vit-base-patch32",
31
+ "model_max_length": 77,
32
+ "special_tokens_map_file": "./special_tokens_map.json",
33
+ "tokenizer_class": "CLIPTokenizer"
34
+ }
vit/clip-vit-H-14-laion2B-s32B-b79K-yi-vl-34B-448/vocab.json ADDED
The diff for this file is too large to render. See raw diff