nielsr HF Staff commited on
Commit
4c0f37b
·
verified ·
1 Parent(s): 1be60e3

Add model card: paper link, image-to-image pipeline, and code link

Browse files

This PR adds a model card with key information to improve discoverability and usability:

* Link to the paper.
* `image-to-image` pipeline tag.

Files changed (1) hide show
  1. README.md +39 -114
README.md CHANGED
@@ -1,201 +1,126 @@
1
  ---
2
  base_model: leloy/Anole-7b-v0.1-hf
3
  library_name: peft
 
 
4
  ---
5
 
6
  # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
- https://arxiv.org/abs/2506.06006
11
 
12
  ## Model Details
13
 
14
  ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
-
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
-
146
- - **Hardware Type:** [More Information Needed]
147
- - **Hours used:** [More Information Needed]
148
- - **Cloud Provider:** [More Information Needed]
149
- - **Compute Region:** [More Information Needed]
150
- - **Carbon Emitted:** [More Information Needed]
151
 
152
  ## Technical Specifications [optional]
153
 
154
  ### Model Architecture and Objective
155
 
156
- [More Information Needed]
157
 
158
  ### Compute Infrastructure
159
 
160
- [More Information Needed]
161
-
162
  #### Hardware
163
 
164
- [More Information Needed]
165
-
166
- #### Software
167
-
168
- [More Information Needed]
169
 
170
  ## Citation [optional]
171
 
172
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
173
-
174
  **BibTeX:**
175
 
176
- [More Information Needed]
177
-
178
- **APA:**
179
-
180
- [More Information Needed]
181
-
182
- ## Glossary [optional]
183
-
184
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
185
-
186
- [More Information Needed]
187
-
188
- ## More Information [optional]
189
-
190
- [More Information Needed]
191
-
192
- ## Model Card Authors [optional]
193
-
194
- [More Information Needed]
195
-
196
- ## Model Card Contact
197
 
198
- [More Information Needed]
199
  ### Framework versions
200
 
201
  - PEFT 0.13.0
 
1
  ---
2
  base_model: leloy/Anole-7b-v0.1-hf
3
  library_name: peft
4
+ license: apache-2.0
5
+ pipeline_tag: image-to-image
6
  ---
7
 
8
  # Model Card for Model ID
9
 
10
+ This model is a LoRA adapter for image editing, as presented in [Bootstrapping World Models from Dynamics Models in Multimodal Foundation Models](https://huggingface.co/papers/2506.06006). It's designed to be used with the base model [leloy/Anole-7b-v0.1-hf](https://huggingface.co/leloy/Anole-7b-v0.1-hf).
 
 
11
 
12
  ## Model Details
13
 
14
  ### Model Description
15
 
16
+ - **Developed by:** [Yifu Qiu, Yftah Ziser, Anna Korhonen, Shay B. Cohen, and Edoardo M. Ponti]
17
+ - **Shared by:** [Yifu Qiu, Yftah Ziser, Anna Korhonen, Shay B. Cohen, and Edoardo M. Ponti]
18
+ - **Model type:** LoRA adapter for image-to-image generation
19
+ - **Language(s) (NLP):** English
20
+ - **License:** Apache 2.0
21
+ - **Finetuned from model [optional]:** [leloy/Anole-7b-v0.1-hf](https://huggingface.co/leloy/Anole-7b-v0.1-hf)
 
 
 
 
 
22
 
23
  ### Model Sources [optional]
24
 
25
+ - **Repository:** https://github.com/dmis-lab/Monet
26
+ - **Paper [optional]:** https://huggingface.co/papers/2506.06006
 
 
27
  - **Demo [optional]:** [More Information Needed]
28
 
29
  ## Uses
30
 
 
 
31
  ### Direct Use
32
 
33
+ Image editing.
 
 
 
 
 
 
 
 
34
 
35
  ### Out-of-Scope Use
36
 
37
+ The model is not intended for use cases that involve generating malicious content.
 
 
38
 
39
  ## Bias, Risks, and Limitations
40
 
41
+ The model may exhibit biases present in the training data.
 
 
42
 
43
  ### Recommendations
44
 
 
 
45
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
46
 
47
  ## How to Get Started with the Model
48
 
49
  Use the code below to get started with the model.
50
 
51
+ Please see https://github.com/dmis-lab/Monet for sample usage.
52
 
53
  ## Training Details
54
 
55
  ### Training Data
56
 
57
+ The model was trained on a combination of synthetic data generated from a dynamics model and a small amount of real-world data.
 
 
58
 
59
  ### Training Procedure
60
 
 
 
61
  #### Preprocessing [optional]
62
 
63
+ The training data was preprocessed by tokenizing the trajectories and computing weights based on importance scores from a recognition model.
 
64
 
65
  #### Training Hyperparameters
66
 
67
+ - **Training regime:** bfloat16 mixed precision
 
 
 
 
 
 
68
 
69
  ## Evaluation
70
 
 
 
71
  ### Testing Data, Factors & Metrics
72
 
73
  #### Testing Data
74
 
75
+ AURORA-Bench
 
 
76
 
77
  #### Factors
78
 
79
+ Real-world and synthetic subsets of AURORA-Bench
 
 
80
 
81
  #### Metrics
82
 
83
+ GPT4o-as-judge, human evaluation
 
 
84
 
85
  ### Results
86
 
87
+ The model achieves performance competitive with state-of-the-art image editing models, improving on them by a margin of 15% on real-world subsets according to GPT4o-as-judge.
 
 
 
 
 
 
 
 
 
 
88
 
89
  ## Environmental Impact
90
 
91
+ - **Hardware Type:** A100
92
+ - **Hours used:** Unknown
93
+ - **Cloud Provider:** Unknown
94
+ - **Compute Region:** Unknown
95
+ - **Carbon Emitted:** Unknown
 
 
 
96
 
97
  ## Technical Specifications [optional]
98
 
99
  ### Model Architecture and Objective
100
 
101
+ The model is based on a vision-and-language foundation model fine-tuned to acquire a dynamics model through supervision.
102
 
103
  ### Compute Infrastructure
104
 
 
 
105
  #### Hardware
106
 
107
+ A100 GPUs
 
 
 
 
108
 
109
  ## Citation [optional]
110
 
 
 
111
  **BibTeX:**
112
 
113
+ ```
114
+ @misc{qiu2025bootstrapping,
115
+ title={Bootstrapping World Models from Dynamics Models in Multimodal Foundation Models},
116
+ author={Yifu Qiu and Yftah Ziser and Anna Korhonen and Shay B. Cohen and Edoardo M. Ponti},
117
+ year={2025},
118
+ eprint={2506.06006},
119
+ archivePrefix={arXiv},
120
+ primaryClass={cs.CV}
121
+ }
122
+ ```
 
 
 
 
 
 
 
 
 
 
 
123
 
 
124
  ### Framework versions
125
 
126
  - PEFT 0.13.0