Gabriel commited on
Commit
cae73c1
1 Parent(s): 7d928da

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -484
README.md CHANGED
@@ -9,487 +9,3 @@ library_name: transformers
9
  ---
10
 
11
  # Qwen2-VL-2B-Instruct
12
-
13
- ## Introduction
14
-
15
- We're excited to unveil **Qwen2-VL**, the latest iteration of our Qwen-VL model, representing nearly a year of innovation.
16
-
17
- ### What’s New in Qwen2-VL?
18
-
19
- #### Key Enhancements:
20
-
21
-
22
- * **SoTA understanding of images of various resolution & ratio**: Qwen2-VL achieves state-of-the-art performance on visual understanding benchmarks, including MathVista, DocVQA, RealWorldQA, MTVQA, etc.
23
-
24
- * **Understanding videos of 20min+**: Qwen2-VL can understand videos over 20 minutes for high-quality video-based question answering, dialog, content creation, etc.
25
-
26
- * **Agent that can operate your mobiles, robots, etc.**: with the abilities of complex reasoning and decision making, Qwen2-VL can be integrated with devices like mobile phones, robots, etc., for automatic operation based on visual environment and text instructions.
27
-
28
- * **Multilingual Support**: to serve global users, besides English and Chinese, Qwen2-VL now supports the understanding of texts in different languages inside images, including most European languages, Japanese, Korean, Arabic, Vietnamese, etc.
29
-
30
-
31
- #### Model Architecture Updates:
32
-
33
- * **Naive Dynamic Resolution**: Unlike before, Qwen2-VL can handle arbitrary image resolutions, mapping them into a dynamic number of visual tokens, offering a more human-like visual processing experience.
34
-
35
- <p align="center">
36
- <img src="https://qianwen-res.oss-accelerate-overseas.aliyuncs.com/Qwen2-VL/qwen2_vl.jpg" width="80%"/>
37
- <p>
38
-
39
- * **Multimodal Rotary Position Embedding (M-ROPE)**: Decomposes positional embedding into parts to capture 1D textual, 2D visual, and 3D video positional information, enhancing its multimodal processing capabilities.
40
-
41
- <p align="center">
42
- <img src="http://qianwen-res.oss-accelerate-overseas.aliyuncs.com/Qwen2-VL/mrope.png" width="80%"/>
43
- <p>
44
-
45
- We have three models with 2, 7 and 72 billion parameters. This repo contains the instruction-tuned 2B Qwen2-VL model. For more information, visit our [Blog](https://qwenlm.github.io/blog/qwen2-vl/) and [GitHub](https://github.com/QwenLM/Qwen2-VL).
46
-
47
-
48
-
49
- ## Evaluation
50
-
51
- ### Image Benchmarks
52
-
53
- | Benchmark | InternVL2-2B | MiniCPM-V 2.0 | **Qwen2-VL-2B** |
54
- | :--- | :---: | :---: | :---: |
55
- | MMMU<sub>val</sub> | 36.3 | 38.2 | **41.1** |
56
- | DocVQA<sub>test</sub> | 86.9 | - | **90.1** |
57
- | InfoVQA<sub>test</sub> | 58.9 | - | **65.5** |
58
- | ChartQA<sub>test</sub> | **76.2** | - | 73.5 |
59
- | TextVQA<sub>val</sub> | 73.4 | - | **79.7** |
60
- | OCRBench | 781 | 605 | **794** |
61
- | MTVQA | - | - | **20.0** |
62
- | VCR<sub>en easy</sub> | - | - | **81.45**
63
- | VCR<sub>zh easy</sub> | - | - | **46.16**
64
- | RealWorldQA | 57.3 | 55.8 | **62.9** |
65
- | MME<sub>sum</sub> | **1876.8** | 1808.6 | 1872.0 |
66
- | MMBench-EN<sub>test</sub> | 73.2 | 69.1 | **74.9** |
67
- | MMBench-CN<sub>test</sub> | 70.9 | 66.5 | **73.5** |
68
- | MMBench-V1.1<sub>test</sub> | 69.6 | 65.8 | **72.2** |
69
- | MMT-Bench<sub>test</sub> | - | - | **54.5** |
70
- | MMStar | **49.8** | 39.1 | 48.0 |
71
- | MMVet<sub>GPT-4-Turbo</sub> | 39.7 | 41.0 | **49.5** |
72
- | HallBench<sub>avg</sub> | 38.0 | 36.1 | **41.7** |
73
- | MathVista<sub>testmini</sub> | **46.0** | 39.8 | 43.0 |
74
- | MathVision | - | - | **12.4** |
75
-
76
- ### Video Benchmarks
77
-
78
- | Benchmark | **Qwen2-VL-2B** |
79
- | :--- | :---: |
80
- | MVBench | **63.2** |
81
- | PerceptionTest<sub>test</sub> | **53.9** |
82
- | EgoSchema<sub>test</sub> | **54.9** |
83
- | Video-MME<sub>wo/w subs</sub> | **55.6**/**60.4** |
84
-
85
-
86
- ## Requirements
87
- The code of Qwen2-VL has been in the latest Hugging face transformers and we advise you to build from source with command `pip install git+https://github.com/huggingface/transformers`, or you might encounter the following error:
88
- ```
89
- KeyError: 'qwen2_vl'
90
- ```
91
-
92
- ## Quickstart
93
- We offer a toolkit to help you handle various types of visual input more conveniently. This includes base64, URLs, and interleaved images and videos. You can install it using the following command:
94
-
95
- ```bash
96
- pip install qwen-vl-utils
97
- ```
98
-
99
- Here we show a code snippet to show you how to use the chat model with `transformers` and `qwen_vl_utils`:
100
-
101
- ```python
102
- from transformers import Qwen2VLForConditionalGeneration, AutoTokenizer, AutoProcessor
103
- from qwen_vl_utils import process_vision_info
104
-
105
- # default: Load the model on the available device(s)
106
- model = Qwen2VLForConditionalGeneration.from_pretrained(
107
- "Qwen/Qwen2-VL-2B-Instruct", torch_dtype="auto", device_map="auto"
108
- )
109
-
110
- # We recommend enabling flash_attention_2 for better acceleration and memory saving, especially in multi-image and video scenarios.
111
- # model = Qwen2VLForConditionalGeneration.from_pretrained(
112
- # "Qwen/Qwen2-VL-2B-Instruct",
113
- # torch_dtype=torch.bfloat16,
114
- # attn_implementation="flash_attention_2",
115
- # device_map="auto",
116
- # )
117
-
118
- # default processer
119
- processor = AutoProcessor.from_pretrained("Qwen/Qwen2-VL-2B-Instruct")
120
-
121
- # The default range for the number of visual tokens per image in the model is 4-16384. You can set min_pixels and max_pixels according to your needs, such as a token count range of 256-1280, to balance speed and memory usage.
122
- # min_pixels = 256*28*28
123
- # max_pixels = 1280*28*28
124
- # processor = AutoProcessor.from_pretrained("Qwen/Qwen2-VL-2B-Instruct", min_pixels=min_pixels, max_pixels=max_pixels)
125
-
126
- messages = [
127
- {
128
- "role": "user",
129
- "content": [
130
- {
131
- "type": "image",
132
- "image": "https://qianwen-res.oss-cn-beijing.aliyuncs.com/Qwen-VL/assets/demo.jpeg",
133
- },
134
- {"type": "text", "text": "Describe this image."},
135
- ],
136
- }
137
- ]
138
-
139
- # Preparation for inference
140
- text = processor.apply_chat_template(
141
- messages, tokenize=False, add_generation_prompt=True
142
- )
143
- image_inputs, video_inputs = process_vision_info(messages)
144
- inputs = processor(
145
- text=[text],
146
- images=image_inputs,
147
- videos=video_inputs,
148
- padding=True,
149
- return_tensors="pt",
150
- )
151
- inputs = inputs.to("cuda")
152
-
153
- # Inference: Generation of the output
154
- generated_ids = model.generate(**inputs, max_new_tokens=128)
155
- generated_ids_trimmed = [
156
- out_ids[len(in_ids) :] for in_ids, out_ids in zip(inputs.input_ids, generated_ids)
157
- ]
158
- output_text = processor.batch_decode(
159
- generated_ids_trimmed, skip_special_tokens=True, clean_up_tokenization_spaces=False
160
- )
161
- print(output_text)
162
- ```
163
- <details>
164
- <summary>Without qwen_vl_utils</summary>
165
-
166
- ```python
167
- from PIL import Image
168
- import requests
169
- import torch
170
- from torchvision import io
171
- from typing import Dict
172
- from transformers import Qwen2VLForConditionalGeneration, AutoTokenizer, AutoProcessor
173
-
174
- # Load the model in half-precision on the available device(s)
175
- model = Qwen2VLForConditionalGeneration.from_pretrained(
176
- "Qwen/Qwen2-VL-2B-Instruct", torch_dtype="auto", device_map="auto"
177
- )
178
- processor = AutoProcessor.from_pretrained("Qwen/Qwen2-VL-2B-Instruct")
179
-
180
- # Image
181
- url = "https://qianwen-res.oss-cn-beijing.aliyuncs.com/Qwen-VL/assets/demo.jpeg"
182
- image = Image.open(requests.get(url, stream=True).raw)
183
-
184
- conversation = [
185
- {
186
- "role": "user",
187
- "content": [
188
- {
189
- "type": "image",
190
- },
191
- {"type": "text", "text": "Describe this image."},
192
- ],
193
- }
194
- ]
195
-
196
-
197
- # Preprocess the inputs
198
- text_prompt = processor.apply_chat_template(conversation, add_generation_prompt=True)
199
- # Excepted output: '<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n<|im_start|>user\n<|vision_start|><|image_pad|><|vision_end|>Describe this image.<|im_end|>\n<|im_start|>assistant\n'
200
-
201
- inputs = processor(
202
- text=[text_prompt], images=[image], padding=True, return_tensors="pt"
203
- )
204
- inputs = inputs.to("cuda")
205
-
206
- # Inference: Generation of the output
207
- output_ids = model.generate(**inputs, max_new_tokens=128)
208
- generated_ids = [
209
- output_ids[len(input_ids) :]
210
- for input_ids, output_ids in zip(inputs.input_ids, output_ids)
211
- ]
212
- output_text = processor.batch_decode(
213
- generated_ids, skip_special_tokens=True, clean_up_tokenization_spaces=True
214
- )
215
- print(output_text)
216
- ```
217
- </details>
218
-
219
- <details>
220
- <summary>Multi image inference</summary>
221
-
222
- ```python
223
- # Messages containing multiple images and a text query
224
- messages = [
225
- {
226
- "role": "user",
227
- "content": [
228
- {"type": "image", "image": "file:///path/to/image1.jpg"},
229
- {"type": "image", "image": "file:///path/to/image2.jpg"},
230
- {"type": "text", "text": "Identify the similarities between these images."},
231
- ],
232
- }
233
- ]
234
-
235
- # Preparation for inference
236
- text = processor.apply_chat_template(
237
- messages, tokenize=False, add_generation_prompt=True
238
- )
239
- image_inputs, video_inputs = process_vision_info(messages)
240
- inputs = processor(
241
- text=[text],
242
- images=image_inputs,
243
- videos=video_inputs,
244
- padding=True,
245
- return_tensors="pt",
246
- )
247
- inputs = inputs.to("cuda")
248
-
249
- # Inference
250
- generated_ids = model.generate(**inputs, max_new_tokens=128)
251
- generated_ids_trimmed = [
252
- out_ids[len(in_ids) :] for in_ids, out_ids in zip(inputs.input_ids, generated_ids)
253
- ]
254
- output_text = processor.batch_decode(
255
- generated_ids_trimmed, skip_special_tokens=True, clean_up_tokenization_spaces=False
256
- )
257
- print(output_text)
258
- ```
259
- </details>
260
-
261
- <details>
262
- <summary>Video inference</summary>
263
-
264
- ```python
265
- # Messages containing a images list as a video and a text query
266
- messages = [
267
- {
268
- "role": "user",
269
- "content": [
270
- {
271
- "type": "video",
272
- "video": [
273
- "file:///path/to/frame1.jpg",
274
- "file:///path/to/frame2.jpg",
275
- "file:///path/to/frame3.jpg",
276
- "file:///path/to/frame4.jpg",
277
- ],
278
- "fps": 1.0,
279
- },
280
- {"type": "text", "text": "Describe this video."},
281
- ],
282
- }
283
- ]
284
- # Messages containing a video and a text query
285
- messages = [
286
- {
287
- "role": "user",
288
- "content": [
289
- {
290
- "type": "video",
291
- "video": "file:///path/to/video1.mp4",
292
- "max_pixels": 360 * 420,
293
- "fps": 1.0,
294
- },
295
- {"type": "text", "text": "Describe this video."},
296
- ],
297
- }
298
- ]
299
-
300
- # Preparation for inference
301
- text = processor.apply_chat_template(
302
- messages, tokenize=False, add_generation_prompt=True
303
- )
304
- image_inputs, video_inputs = process_vision_info(messages)
305
- inputs = processor(
306
- text=[text],
307
- images=image_inputs,
308
- videos=video_inputs,
309
- padding=True,
310
- return_tensors="pt",
311
- )
312
- inputs = inputs.to("cuda")
313
-
314
- # Inference
315
- generated_ids = model.generate(**inputs, max_new_tokens=128)
316
- generated_ids_trimmed = [
317
- out_ids[len(in_ids) :] for in_ids, out_ids in zip(inputs.input_ids, generated_ids)
318
- ]
319
- output_text = processor.batch_decode(
320
- generated_ids_trimmed, skip_special_tokens=True, clean_up_tokenization_spaces=False
321
- )
322
- print(output_text)
323
- ```
324
- </details>
325
-
326
- <details>
327
- <summary>Batch inference</summary>
328
-
329
- ```python
330
- # Sample messages for batch inference
331
- messages1 = [
332
- {
333
- "role": "user",
334
- "content": [
335
- {"type": "image", "image": "file:///path/to/image1.jpg"},
336
- {"type": "image", "image": "file:///path/to/image2.jpg"},
337
- {"type": "text", "text": "What are the common elements in these pictures?"},
338
- ],
339
- }
340
- ]
341
- messages2 = [
342
- {"role": "system", "content": "You are a helpful assistant."},
343
- {"role": "user", "content": "Who are you?"},
344
- ]
345
- # Combine messages for batch processing
346
- messages = [messages1, messages1]
347
-
348
- # Preparation for batch inference
349
- texts = [
350
- processor.apply_chat_template(msg, tokenize=False, add_generation_prompt=True)
351
- for msg in messages
352
- ]
353
- image_inputs, video_inputs = process_vision_info(messages)
354
- inputs = processor(
355
- text=texts,
356
- images=image_inputs,
357
- videos=video_inputs,
358
- padding=True,
359
- return_tensors="pt",
360
- )
361
- inputs = inputs.to("cuda")
362
-
363
- # Batch Inference
364
- generated_ids = model.generate(**inputs, max_new_tokens=128)
365
- generated_ids_trimmed = [
366
- out_ids[len(in_ids) :] for in_ids, out_ids in zip(inputs.input_ids, generated_ids)
367
- ]
368
- output_texts = processor.batch_decode(
369
- generated_ids_trimmed, skip_special_tokens=True, clean_up_tokenization_spaces=False
370
- )
371
- print(output_texts)
372
- ```
373
- </details>
374
-
375
- ### More Usage Tips
376
-
377
- For input images, we support local files, base64, and URLs. For videos, we currently only support local files.
378
-
379
- ```python
380
- # You can directly insert a local file path, a URL, or a base64-encoded image into the position where you want in the text.
381
- ## Local file path
382
- messages = [
383
- {
384
- "role": "user",
385
- "content": [
386
- {"type": "image", "image": "file:///path/to/your/image.jpg"},
387
- {"type": "text", "text": "Describe this image."},
388
- ],
389
- }
390
- ]
391
- ## Image URL
392
- messages = [
393
- {
394
- "role": "user",
395
- "content": [
396
- {"type": "image", "image": "http://path/to/your/image.jpg"},
397
- {"type": "text", "text": "Describe this image."},
398
- ],
399
- }
400
- ]
401
- ## Base64 encoded image
402
- messages = [
403
- {
404
- "role": "user",
405
- "content": [
406
- {"type": "image", "image": "data:image;base64,/9j/..."},
407
- {"type": "text", "text": "Describe this image."},
408
- ],
409
- }
410
- ]
411
- ```
412
- #### Image Resolution for performance boost
413
-
414
- The model supports a wide range of resolution inputs. By default, it uses the native resolution for input, but higher resolutions can enhance performance at the cost of more computation. Users can set the minimum and maximum number of pixels to achieve an optimal configuration for their needs, such as a token count range of 256-1280, to balance speed and memory usage.
415
-
416
- ```python
417
- min_pixels = 256 * 28 * 28
418
- max_pixels = 1280 * 28 * 28
419
- processor = AutoProcessor.from_pretrained(
420
- "Qwen/Qwen2-VL-2B-Instruct", min_pixels=min_pixels, max_pixels=max_pixels
421
- )
422
- ```
423
-
424
- Besides, We provide two methods for fine-grained control over the image size input to the model:
425
-
426
- 1. Define min_pixels and max_pixels: Images will be resized to maintain their aspect ratio within the range of min_pixels and max_pixels.
427
-
428
- 2. Specify exact dimensions: Directly set `resized_height` and `resized_width`. These values will be rounded to the nearest multiple of 28.
429
-
430
- ```python
431
- # min_pixels and max_pixels
432
- messages = [
433
- {
434
- "role": "user",
435
- "content": [
436
- {
437
- "type": "image",
438
- "image": "file:///path/to/your/image.jpg",
439
- "resized_height": 280,
440
- "resized_width": 420,
441
- },
442
- {"type": "text", "text": "Describe this image."},
443
- ],
444
- }
445
- ]
446
- # resized_height and resized_width
447
- messages = [
448
- {
449
- "role": "user",
450
- "content": [
451
- {
452
- "type": "image",
453
- "image": "file:///path/to/your/image.jpg",
454
- "min_pixels": 50176,
455
- "max_pixels": 50176,
456
- },
457
- {"type": "text", "text": "Describe this image."},
458
- ],
459
- }
460
- ]
461
- ```
462
-
463
- ## Limitations
464
-
465
- While Qwen2-VL are applicable to a wide range of visual tasks, it is equally important to understand its limitations. Here are some known restrictions:
466
-
467
- 1. Lack of Audio Support: The current model does **not comprehend audio information** within videos.
468
- 2. Data timeliness: Our image dataset is **updated until June 2023**, and information subsequent to this date may not be covered.
469
- 3. Constraints in Individuals and Intellectual Property (IP): The model's capacity to recognize specific individuals or IPs is limited, potentially failing to comprehensively cover all well-known personalities or brands.
470
- 4. Limited Capacity for Complex Instruction: When faced with intricate multi-step instructions, the model's understanding and execution capabilities require enhancement.
471
- 5. Insufficient Counting Accuracy: Particularly in complex scenes, the accuracy of object counting is not high, necessitating further improvements.
472
- 6. Weak Spatial Reasoning Skills: Especially in 3D spaces, the model's inference of object positional relationships is inadequate, making it difficult to precisely judge the relative positions of objects.
473
-
474
- These limitations serve as ongoing directions for model optimization and improvement, and we are committed to continually enhancing the model's performance and scope of application.
475
-
476
-
477
- ## Citation
478
-
479
- If you find our work helpful, feel free to give us a cite.
480
-
481
- ```
482
- @article{Qwen2VL,
483
- title={Qwen2-VL: Enhancing Vision-Language Model's Perception of the World at Any Resolution},
484
- author={Wang, Peng and Bai, Shuai and Tan, Sinan and Wang, Shijie and Fan, Zhihao and Bai, Jinze and Chen, Keqin and Liu, Xuejing and Wang, Jialin and Ge, Wenbin and Fan, Yang and Dang, Kai and Du, Mengfei and Ren, Xuancheng and Men, Rui and Liu, Dayiheng and Zhou, Chang and Zhou, Jingren and Lin, Junyang},
485
- journal={arXiv preprint arXiv:2409.12191},
486
- year={2024}
487
- }
488
-
489
- @article{Qwen-VL,
490
- title={Qwen-VL: A Versatile Vision-Language Model for Understanding, Localization, Text Reading, and Beyond},
491
- author={Bai, Jinze and Bai, Shuai and Yang, Shusheng and Wang, Shijie and Tan, Sinan and Wang, Peng and Lin, Junyang and Zhou, Chang and Zhou, Jingren},
492
- journal={arXiv preprint arXiv:2308.12966},
493
- year={2023}
494
- }
495
- ```
 
9
  ---
10
 
11
  # Qwen2-VL-2B-Instruct