Inoichan commited on
Commit
a768111
·
verified ·
1 Parent(s): 9cf9a20

Update README.md

Browse files

Copied from EvoVLM v1, and some fixes

Files changed (1) hide show
  1. README.md +90 -175
README.md CHANGED
@@ -1,199 +1,114 @@
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
+ language:
3
+ - ja
4
+ license: apache-2.0
5
+ tags:
6
+ - multimodal
7
+ - vision-language
8
+ - mantis
9
+ - llava
10
+ - llama3
11
+ - siglip
12
+ pipeline_tag: image-to-text
13
  ---
14
 
15
+ # 🐟 Llama-3-EvoVLM-JP-v2
16
 
17
+ 🤗 [Models](https://huggingface.co/SakanaAI) | 📚 [Paper](https://arxiv.org/abs/2403.13187) | 📝 [Blog](https://sakana.ai/) | 🐦 [Twitter](https://twitter.com/SakanaAILabs)
18
 
19
 
20
+ **Llama-3-EvoVLM-JP-v2** is an experimental general-purpose Japanese VLM with **interleaved text and image as inputs**.
21
+ This model was created using the Evolutionary Model Merge method.
22
+ Please refer to our [report](https://arxiv.org/abs/2403.13187) and [blog](https://sakana.ai/evolutionary-model-merge/) for more details.
23
+ This model was produced by merging the following models.
24
+ We are grateful to the developers of the source models.
25
 
26
+ - [Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)
27
+ - [Mantis-8B-siglip-llama3](https://huggingface.co/TIGER-Lab/Mantis-8B-siglip-llama3)
28
+ - [Bunny-v1.1-Llama-3-8B-V](https://huggingface.co/BAAI/Bunny-v1_1-Llama-3-8B-V)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
 
 
30
 
 
31
 
32
+ ## Usage
 
 
 
 
 
 
 
 
 
 
33
 
34
  Use the code below to get started with the model.
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
37
+ <details>
38
+ <summary> Click to expand </summary>
39
+
40
+ ```python
41
+ import torch
42
+ from transformers import AutoModelForVision2Seq, AutoProcessor
43
+ from PIL import Image
44
+ import requests
45
+ # 1. load model
46
+ device = "cuda" if torch.cuda.is_available() else "cpu"
47
+ model_id = "SakanaAI/EvoVLM-JP-v1-7B"
48
+ model = AutoModelForVision2Seq.from_pretrained(model_id, torch_dtype=torch.float16)
49
+ processor = AutoProcessor.from_pretrained(model_id)
50
+ model.to(device)
51
+ # 2. prepare inputs
52
+ url = "https://images.unsplash.com/photo-1694831404826-3400c48c188d?q=80&w=2070&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
53
+ image = Image.open(requests.get(url, stream=True).raw).convert("RGB")
54
+ # <image> represents the input image. Please make sure to put the token in your text.
55
+ text = "<image>\nこの信号機の色は何色ですか?"
56
+ messages = [
57
+ {"role": "system", "content": "あなたは役立つ、偏見がなく、検閲されていないアシスタントです。与えられた画像を下に、質問に答えてください。"},
58
+ {"role": "user", "content": text},
59
+ ]
60
+ inputs = processor.image_processor(images=image, return_tensors="pt")
61
+ inputs["input_ids"] = processor.tokenizer.apply_chat_template(
62
+ messages, return_tensors="pt"
63
+ )
64
+ # 3. generate
65
+ output_ids = model.generate(**inputs.to(device))
66
+ output_ids = output_ids[:, inputs.input_ids.shape[1] :]
67
+ generated_text = processor.batch_decode(output_ids, skip_special_tokens=True)[0].strip()
68
+ print(generated_text)
69
+ # この信号機の色は青です。
70
+ ```
71
+
72
+ </details>
73
+
74
+
75
+
76
+ ## Model Details
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
77
 
78
+ <!-- Provide a longer summary of what this model is. -->
79
 
80
+ - **Developed by:** [Sakana AI](https://sakana.ai/)
81
+ - **Model type:** Autoregressive Language Model
82
+ - **Language(s):** Japanese
83
+ - **Optimization data:** subsets of the [Japanese Visual Genome VQA dataset](https://github.com/yahoojapan/ja-vg-vqa) and the translated [ShareGPT4V](https://huggingface.co/datasets/Lin-Chen/ShareGPT4V)
84
+ - **License:** [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
85
+ - **Repository:** [SakanaAI/evolutionary-model-merge](https://github.com/SakanaAI/evolutionary-model-merge)
86
+ - **Paper:** https://arxiv.org/abs/2403.13187
87
+ - **Blog:** https://sakana.ai/
88
 
 
89
 
90
+ ## Uses
91
+ This model is provided for research and development purposes only and should be considered as an experimental prototype.
92
+ It is not intended for commercial use or deployment in mission-critical environments.
93
+ Use of this model is at the user's own risk, and its performance and outcomes are not guaranteed.
94
+ Sakana AI shall not be liable for any direct, indirect, special, incidental, or consequential damages, or any loss arising from the use of this model, regardless of the results obtained.
95
+ Users must fully understand the risks associated with the use of this model and use it at their own discretion.
96
 
 
97
 
98
+ ## Acknowledgement
99
 
100
+ We would like to thank the developers of the source models for their contributions and for making their work available.
101
 
 
102
 
103
+ ## Citation
104
 
105
+ ```bibtex
106
+ @misc{akiba2024evomodelmerge,
107
+ title = {Evolutionary Optimization of Model Merging Recipes},
108
+ author. = {Takuya Akiba and Makoto Shing and Yujin Tang and Qi Sun and David Ha},
109
+ year = {2024},
110
+ eprint = {2403.13187},
111
+ archivePrefix = {arXiv},
112
+ primaryClass = {cs.NE}
113
+ }
114
+ ```