khang119966 commited on
Commit
a901bcb
1 Parent(s): e829a1d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +177 -196
README.md CHANGED
@@ -1,199 +1,180 @@
1
  ---
2
  library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
-
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
-
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ language:
4
+ - vi
5
+ - en
6
+ base_model:
7
+ - 5CD-AI/Vintern-1B-v2
8
+ datasets:
9
+ - vidore/colpali_train_set
10
+ - 5CD-AI/Viet-Doc-VQA
11
+ - 5CD-AI/Viet-OCR-VQA
12
+ - 5CD-AI/Viet-Doc-VQA-II
13
+ tags:
14
+ - colpali
15
  ---
16
+ <div align="center">
17
+ <img src="Vintern3B-logo.jpg" width="700"/>
18
+ </div>
19
+
20
+ ## Vintern-3B-beta 🇻🇳 ❄️ - The LLaVA 🌋 Challenger
21
+
22
+ **What's new in Vintern-3B-beta!**
23
+ - **We successfully reproduced the training process of InternVL from scratch.**
24
+ - The model is the result of integrating [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct) and [InternViT-300M-448px](https://huggingface.co/OpenGVLab/InternViT-300M-448px) through an MLP layer.
25
+ - Trained with more than 10 Milion Vietnamese QnAs, Descriptions, and 10% English, Chinese Data from [OpenGVLab/InternVL-Chat-V1-2-SFT-Data](https://huggingface.co/datasets/OpenGVLab/InternVL-Chat-V1-2-SFT-Data).
26
+
27
+
28
+ ## Colpali Benchmarks
29
+
30
+ | | ArxivQ | DocQ | InfoQ | TATQ | AI | Energy | Gov. | Health. | Avg. |
31
+ |:------------------------------:|:--------:|:------:|:-------:|:------:|:------:|:--------:|:-------:|:---------:|:--------:|
32
+ | **Unstructured** Text only | | | | | | | | | |
33
+ | - BM25 | - | 34.1 | - | 44.0 | 90.4 | 78.3 | 78.8 | 82.6 | - |
34
+ | - BGE-M3 | - | 28.4 | - | 36.1 | 88.4 | 76.8 | 77.7 | 84.6 | - |
35
+ | **Unstructured** + OCR | | | | | | | | | |
36
+ | - BM25 | 31.6 | 36.8 | 62.9 | 62.7 | 92.8 | 85.9 | 83.9 | 87.2 | 68.0 |
37
+ | - BGE-M3 | 31.4 | 25.7 | 60.1 | 50.5 | 90.2 | 83.6 | 84.9 | 91.1 | 64.7 |
38
+ | **Unstructured** + Captioning | | | | | | | | | |
39
+ | - BM25 | 40.1 | 38.4 | 70.0 | 61.5 | 88.0 | 84.7 | 82.7 | 89.2 | 69.3 |
40
+ | - BGE-M3 | 35.7 | 32.9 | 71.9 | 43.8 | 88.8 | 83.3 | 80.4 | 91.3 | 66.0 |
41
+ | **Contrastive VLMs** | | | | | | | | | |
42
+ | - Jina-CLIP | 25.4 | 11.9 | 35.5 | 3.3 | 15.2 | 19.7 | 21.4 | 20.8 | 19.2 |
43
+ | - Nomic-vision | 17.1 | 10.7 | 30.1 | 2.7 | 12.9 | 10.9 | 11.4 | 15.7 | 13.9 |
44
+ | - SigLIP (Vanilla) | 43.2 | 30.3 | 64.1 | 26.2 | 62.5 | 65.7 | 66.1 | 79.1 | 54.7 |
45
+ | **Colpali** | | | | | | | | | |
46
+ | - SigLIP (Vanilla) | 43.2 | 30.3 | 64.1 | 26.2 | 62.5 | 65.7 | 66.1 | 79.1 | 54.7 |
47
+ | - BiSigLIP (+fine-tuning) | 58.5 | 32.9 | 70.5 | 30.5 | 74.3 | 73.7 | 74.2 | 82.3 | 62.1 |
48
+ | - BiPali (+LLM) | 56.5 | 30.0 | 67.4 | 33.4 | 71.2 | 61.9 | 73.8 | 73.6 | 58.5 |
49
+ | - ColPali (+Late Inter.) | **79.1** | **54.4** | 81.8 | **65.8** | **96.2** | **91.0** | **92.7** | 94.4 | **81.3** |
50
+ | **Ours** | | | | | | | | | |
51
+ | - ColVintern-1B (+Late Inter.) | 71.6 | 48.3 | **84.6** | 59.6 | 92.9 | 88.7 | 89.4 | **95.2** | 78.8 |
52
+
53
+
54
+ ## Vietnamese Benchmarks
55
+
56
+ ## Examples
57
+
58
+ <div align="center">
59
+ <img src="ex_6.jpg" width="400"/>
60
+ </div>
61
+
62
+
63
+ ```
64
+ User: <image>
65
+ tả hình ảnh chi tiết.
66
+ Assistant: Bức ảnh là một giao diện ứng dụng đặt hàng thức ăn trực tuyến. Giao diện được chia thành các phần:
67
+ - Phần đầu tiên hiển thị thông báo "Sẽ xong lúc 10:50 SA" và dòng chữ "Bếp đang thực hiện món.". Bên cạnh đó là biểu tượng bếp đang hoạt động với thanh tiến độ màu xanh lá cây.
68
+ - Tiếp theo là dòng chữ "Vui lòng đến lấy món trước 12:50".
69
+ - Phần tiếp theo là thông tin về quán cà phê "Wego Coffee - Mapletree Business Centre", kèm theo dòng chữ "#GF-29".
70
+ - Dòng chữ "Đừng quên kiểm tra lại để chắc rằng bạn nhận đúng món nhé!" được hiển thị trong một khung hình chữ nhật màu be.
71
+ - Phần cuối cùng thông tin về đơn hàng, bao gồm logo quán cà phê, dòng chữ "Wego Coffee - Mapletree Business Centre", dòng chữ "Tổng cộng", giá trị đơn hàng (70.000đ), giá trị thanh toán (120.000đ) và dòng chữ "Merchants has not started a chat".
72
+ - Cuối cùng là nút "Xem tóm tắt đơn hàng" và nút "Đã lấy món" có màu xanh lá cây.
73
+ ```
74
+
75
+
76
+ <div align="center">
77
+ <img src="ex_1.jpg" width="400"/>
78
+ </div>
79
+
80
+ ```
81
+ User: <image>
82
+ Liệt kê toàn bộ bài thơ có trong ảnh.
83
+ Assistant: Đi khắp thế gian không ai tốt bằng mẹ Gánh nặng cuộc đời không ai khổ bằng cha
84
+ ```
85
+
86
+ <div align="center">
87
+ <img src="ex_2.jpg" width="400"/>
88
+ </div>
89
+
90
+ ```
91
+ User: <image>
92
+ Liệt kê toàn bộ bài thơ có trong ảnh.
93
+ Assistant: Bài thơ có nội dung:
94
+ - Mẹ như một ngọn hải đăng
95
+ - Như ông mặt trời, như ông mặt trăng
96
+ - Ngày ngày vất vả, tảo tần
97
+ - Chăm lo con cái, làm việc siêng năng.
98
+ ```
99
+
100
+ <div align="center">
101
+ <img src="ex_3.png" width="400"/>
102
+ </div>
103
+
104
+ ```
105
+ User: <image>
106
+ tả hình ảnh chi tiết.
107
+ Assistant: Bức ảnh chụp một bảng đen với các công thức toán học được viết bằng phấn trắng. Ở góc trên bên trái, có dòng chữ "20/19/SGK" được viết bằng màu vàng nhạt. Tiếp theo là phần a) với hai phương trình:
108
+ 3x + y = 3
109
+ 2x - y = 7
110
+ Dưới hai phương trình này mũi tên chỉ sang phải hai phương trình mới:
111
+ 5x = 10
112
+ 3x + y = 3
113
+ 3.2 + y = 3
114
+ Sau đó là dòng chữ "x = 2"
115
+ y = -3
116
+ Cuối cùng dòng chữ "Vậy hpt đã cho no! (x; y) = (2; -3)"
117
+ ```
118
+
119
+ <div align="center">
120
+ <img src="ex_4.jpg" width="400"/>
121
+ </div>
122
+
123
+ ```
124
+ User: <image>
125
+ Mô tả hình ảnh chi tiết.
126
+ Assistant: Bức ảnh minh họa quá trình xử lý hình ảnh bằng mạng lưới thần kinh nhân tạo (CNN). Bức ảnh được chia thành 3 phần chính:
127
+
128
+ 1. **Phần đầu tiên:** Hiển thị một hình ảnh của một chiếc xe hơi màu trắng với dòng chữ "input image" ở bên dưới.
129
+ 2. **Phần thứ hai:** Hiển thị 6 khối vuông, mỗi khối đại diện cho một lớp trong mạng CNN. Các lớp được đánh số thứ tự từ trái sang phải:
130
+ * Convolutional layer
131
+ * Pooling layer
132
+ * Convolutional layer
133
+ * Pooling layer
134
+ * Fully-connected layer
135
+ * Predicted class
136
+ 3. **Phần thứ ba:** Hiển thị một hình ảnh với dòng chữ "car" ở bên dưới.
137
+
138
+ Một mũi tên màu đen nối các khối vuông với nhau, thể hiện quá trình truyền dữ liệu giữa các lớp.
139
+ ```
140
+
141
+ ## Quickstart
142
+
143
+
144
+ ```python
145
+ import torch
146
+ from PIL import Image
147
+
148
+ from transformers import AutoModel, AutoTokenizer, AutoProcessor
149
+
150
+ # from colpali_engine.models import ColQwen2, ColQwen2Processor
151
+ # from colpali_engine.models import ColInternVL2Processor, ColInternVL2
152
+
153
+ model_name = "5CD-AI/ColVintern-1B-v1"
154
+
155
+ processor = AutoProcessor.from_pretrained(
156
+ model_name,
157
+ trust_remote_code=True
158
+ )
159
+ model = AutoModel.from_pretrained(
160
+ model_name,
161
+ torch_dtype=torch.bfloat16,
162
+ low_cpu_mem_usage=True,
163
+ trust_remote_code=True,
164
+ ).eval().cuda()
165
+
166
+ ```
167
+
168
+ ## Citation
169
+
170
+ <!-- ```
171
+ @misc{doan2024vintern1befficientmultimodallarge,
172
+ title={Vintern-1B: An Efficient Multimodal Large Language Model for Vietnamese},
173
+ author={Khang T. Doan and Bao G. Huynh and Dung T. Hoang and Thuc D. Pham and Nhat H. Pham and Quan T. M. Nguyen and Bang Q. Vo and Suong N. Hoang},
174
+ year={2024},
175
+ eprint={2408.12480},
176
+ archivePrefix={arXiv},
177
+ primaryClass={cs.LG},
178
+ url={https://arxiv.org/abs/2408.12480},
179
+ }
180
+ ``` -->