English
COCOM
custom_code
maxoul commited on
Commit
c6eda8c
·
verified ·
1 Parent(s): 0931656

Upload COCOM

Browse files
Files changed (4) hide show
  1. adapters.pth +3 -0
  2. config.json +35 -0
  3. decoder_first_last_layers.pth +3 -0
  4. modelling_pisco.py +1095 -0
adapters.pth ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:270428eed2fd3fdc043ba69cc29edfe91e08b46db3935eba09fc53b18b96f099
3
+ size 168063670
config.json ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_attn_implementation_autoset": true,
3
+ "ae_mode": "token",
4
+ "attn_implementation": null,
5
+ "auto_map": {
6
+ "AutoConfig": "modelling_pisco.COCOMConfig"
7
+ },
8
+ "compr_base_model_name": "mistralai/Mistral-7B-Instruct-v0.2",
9
+ "compr_every_n_layer": null,
10
+ "compr_linear_type": "concat",
11
+ "compr_mlp_hidden_dim": 8096,
12
+ "compr_model_name": null,
13
+ "compr_n_layers": null,
14
+ "compr_rate": 16,
15
+ "compr_rms_norm": false,
16
+ "compr_use_mlp": true,
17
+ "decoder_model_name": "mistralai/Mistral-7B-Instruct-v0.2",
18
+ "device_map": null,
19
+ "different_mem_tokens": true,
20
+ "doc_max_length": 128,
21
+ "generation_top_k": 1,
22
+ "kbtc_training": false,
23
+ "load_adapters": true,
24
+ "lora": true,
25
+ "lora_compressor": false,
26
+ "lora_r": 16,
27
+ "lora_r_compressor": 16,
28
+ "max_new_tokens": 128,
29
+ "model_type": "COCOM",
30
+ "optimize_mem_tokens": true,
31
+ "quantization": "no",
32
+ "sep": true,
33
+ "training_form": "both_separately",
34
+ "transformers_version": "4.48.0"
35
+ }
decoder_first_last_layers.pth ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:10ff1246169cded9d4159a3e31978f9125504e2a346daf1e238c0a24664bc57c
3
+ size 524469892
modelling_pisco.py ADDED
@@ -0,0 +1,1095 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ import warnings
2
+ import os
3
+ import torch
4
+ import gc
5
+
6
+ from torch import nn
7
+ from jinja2.exceptions import TemplateError
8
+ from peft import LoraConfig
9
+ from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig, PreTrainedModel, PretrainedConfig, AutoModel, AutoConfig
10
+
11
+
12
+ def get_first_layers_model(base_model_name: str, n_layers: int, attn_implementation: str = 'flash_attention_2'):
13
+ """
14
+ Builds a model comprising only the n_layers first layer of the base_model_name
15
+ (it keeps the embedding and head layers)
16
+ """
17
+ full_model = AutoModelForCausalLM.from_pretrained(base_model_name)
18
+
19
+ # Create a new config for a model with fewer layers (e.g., 3 layers)
20
+ custom_config = AutoConfig.from_pretrained(base_model_name)
21
+ custom_config.num_hidden_layers = n_layers
22
+ first_layers_model = AutoModelForCausalLM.from_config(config=custom_config, attn_implementation=attn_implementation, torch_dtype=torch.bfloat16)
23
+
24
+ # Load the state dict of the full model
25
+ full_state_dict = full_model.state_dict()
26
+ custom_state_dict = first_layers_model.state_dict()
27
+ kept_state_dict = {k:v for k,v in full_state_dict.items() if k in custom_state_dict}
28
+
29
+ first_layers_model.load_state_dict(kept_state_dict, strict=True)
30
+
31
+ del full_model
32
+ torch.cuda.empty_cache()
33
+ gc.collect()
34
+
35
+ return first_layers_model
36
+
37
+
38
+ def get_every_n_layer_model(base_model_name: str, every_n_layer: int, attn_implementation: str = 'flash_attention_2'):
39
+ """
40
+ Builds a model comprising 1 every every_n_layer layer of the base_model_name
41
+ (it keeps the embedding and head layers)
42
+ """
43
+ full_model = AutoModelForCausalLM.from_pretrained(base_model_name)
44
+ n_kept_layers = full_model.config.num_hidden_layers // every_n_layer
45
+
46
+ print(f'New model with 1/{every_n_layer} from {base_model_name} will have {n_kept_layers} layers')
47
+
48
+ custom_config = AutoConfig.from_pretrained(base_model_name)
49
+ custom_config.num_hidden_layers = n_kept_layers
50
+ custom_model = AutoModelForCausalLM.from_config(config=custom_config,
51
+ attn_implementation=attn_implementation,
52
+ torch_dtype=torch.bfloat16)
53
+ full_state_dict = full_model.state_dict()
54
+ custom_state_dict = custom_model.state_dict()
55
+
56
+ # Filter out every Nth layer and rename to form a new state dict
57
+ kept_state_dict = {}
58
+ for key, value in full_state_dict.items():
59
+ if ".layers." in key:
60
+ # Extract layer index
61
+ layer_idx = int(key.split(".layers.")[1].split(".")[0])
62
+ # Check if it's an Nth layer
63
+ if layer_idx % every_n_layer == 0:
64
+ # Adjust layer index for the smaller model
65
+ new_layer_idx = layer_idx // every_n_layer
66
+ # print('replacing', f".layers.{layer_idx}.", f".layers.{new_layer_idx}.")
67
+ new_key = key.replace(f".layers.{layer_idx}.", f".layers.{new_layer_idx}.")
68
+ if new_key in custom_state_dict:
69
+ kept_state_dict[new_key] = value
70
+ else:
71
+ # Keep non-layer-specific parameters
72
+ if key in custom_state_dict:
73
+ kept_state_dict[key] = value
74
+
75
+ # Load the filtered state dict into the custom model
76
+ custom_model.load_state_dict(kept_state_dict, strict=True)
77
+
78
+ del full_model
79
+ torch.cuda.empty_cache()
80
+ gc.collect()
81
+
82
+ return custom_model
83
+
84
+
85
+ class MistralTrimmed(torch.nn.Module):
86
+ """
87
+ Trimmed version of base models for faster compression
88
+ NB: the name 'MistralTrimmed' suggests it just works with mistral but NO in fact most LLMs are supported !
89
+ """
90
+ def __init__(self,
91
+ n_layers: int = 15,
92
+ every_n_layer: int = None,
93
+ rms_norm: bool = False,
94
+ base_model_name: str = 'mistralai/Mistral-7B-Instruct-v0.2',
95
+ attn_implementation: str = 'flash_attention_2'):
96
+ """
97
+ you can either specify
98
+ - n_layers to some number: we take the n_layers first layers of the base model.
99
+ - every_n_layer to some number: in that case we take 1/N layer of the base model
100
+ The base_model_name is the name of the model from which this model is built.
101
+ """
102
+ assert (n_layers is None) ^ (every_n_layer is None), 'Cannot specify both n_layers and every_n_layer for MistralTrimmed'
103
+ super().__init__()
104
+
105
+ self.n_layers = n_layers
106
+ self.every_n_layer = every_n_layer
107
+ self.base_model_name = base_model_name
108
+
109
+ if n_layers is not None:
110
+ self.custom_model = get_first_layers_model(self.base_model_name,
111
+ n_layers,
112
+ attn_implementation=attn_implementation)
113
+
114
+ else:
115
+ self.custom_model = get_every_n_layer_model(self.base_model_name,
116
+ every_n_layer,
117
+ attn_implementation=attn_implementation)
118
+
119
+ self.custom_model = self.custom_model.bfloat16()
120
+ self.custom_model.cuda()
121
+
122
+ if rms_norm:
123
+ print('Compressor keeps its original rms norm')
124
+ else:
125
+ print('De-activating RMS norm in compressor')
126
+ # We deactivate the norm: we don't need it here since we want to manipulate stuff within embed space
127
+ # see https://github.com/huggingface/transformers/blob/v4.45.0/src/transformers/models/mistral/modeling_mistral.py#L699
128
+ self.custom_model.model.norm = nn.Identity()
129
+
130
+ # Piping useful methods:
131
+ self.add_adapter = self.custom_model.add_adapter
132
+ self.set_adapter = self.custom_model.set_adapter
133
+ self.load_adapter = self.custom_model.load_adapter
134
+ self.num_parameters = self.custom_model.num_parameters
135
+ self.resize_token_embeddings = self.custom_model.resize_token_embeddings
136
+ self.get_input_embeddings = self.custom_model.get_input_embeddings
137
+ self.get_adapter_state_dict = self.custom_model.get_adapter_state_dict
138
+
139
+ # self.custom_model.gradient_checkpointing_enable()
140
+
141
+ # del self.custom_model.lm_head # THIS FAILS since some models have tie_embeddings=True !
142
+ # gc.collect()
143
+ # torch.cuda.empty_cache()
144
+
145
+ def forward(self, input_ids, attention_mask=None):
146
+ return self.custom_model.model(input_ids, attention_mask, output_hidden_states=True) # we call the .model attribute of the causal LM to avoid the cost of the LM head ! nice huh ?
147
+
148
+ def __call__(self, input_ids, attention_mask=None, output_hidden_states=True):
149
+ return self.forward(input_ids, attention_mask)
150
+
151
+
152
+ class AbstractCompressor(nn.Module):
153
+ def __init__(self, compr_model_name: str, compr_rate: int, decoder_hidden_size: int):
154
+ super().__init__()
155
+ self.compr_model_name = compr_model_name
156
+ self.compr_rate = compr_rate
157
+ self.decoder_hidden_size = decoder_hidden_size
158
+
159
+ def forward(self, input_ids, attention_mask, generation_top_k):
160
+ """
161
+ input_ids of shape (batch_size, top_k, seq_length)
162
+ attention_mask of shape (batch_size, top_k, seq_length)
163
+ generation_top_k: the number of docs
164
+ """
165
+ raise NotImplementedError
166
+
167
+ def save_pretrained(self, save_directory):
168
+ raise NotImplementedError
169
+
170
+ def load_pretrained(self, load_directory):
171
+ raise NotImplementedError
172
+
173
+
174
+ class BertCompressor(AbstractCompressor):
175
+ def __init__(self,
176
+ compr_model_name: str,
177
+ compr_rate: int,
178
+ decoder_hidden_size: int,
179
+ mlp_hidden_dim: int = 8192,
180
+ use_mlp: bool = True,
181
+ doc_max_length : int = 128,
182
+ **kwargs):
183
+ # TODO use the device_map
184
+ super().__init__(compr_model_name=compr_model_name, compr_rate=compr_rate, decoder_hidden_size=decoder_hidden_size)
185
+ if compr_model_name == 'mistral_trimmed':
186
+ assert 'compr_n_layers' in kwargs
187
+ self.model = MistralTrimmed(n_layers=kwargs['compr_n_layers'],
188
+ every_n_layer=kwargs['compr_every_n_layer'],
189
+ rms_norm=kwargs['compr_rms_norm'],
190
+ base_model_name=kwargs['compr_base_model_name'],
191
+ attn_implementation=kwargs['attn_implementation'])
192
+ self.tokenizer = AutoTokenizer.from_pretrained(self.model.base_model_name)
193
+ self.hidden_size = self.model.custom_model.config.hidden_size
194
+ else:
195
+ self.model = AutoModel.from_pretrained(compr_model_name, torch_dtype=torch.bfloat16, device_map='auto')
196
+ self.tokenizer = AutoTokenizer.from_pretrained(compr_model_name, use_fast=True)
197
+ self.tokenizer.padding_side = "left"
198
+ self.hidden_size = self.model.config.hidden_size
199
+
200
+ print('Base compressor nb parameters', self.model.num_parameters())
201
+
202
+ self.mlp_hidden_dim = mlp_hidden_dim
203
+ self.use_mlp = use_mlp
204
+ self.doc_max_length = doc_max_length
205
+
206
+ if self.use_mlp:
207
+ self.mlp = nn.Sequential(
208
+ nn.Linear(self.hidden_size, self.mlp_hidden_dim),
209
+ nn.ReLU(),
210
+ nn.Linear(self.mlp_hidden_dim, decoder_hidden_size)
211
+ ).bfloat16()
212
+ self.mlp.cuda()
213
+
214
+ self.n_emb = self.doc_max_length // self.compr_rate
215
+
216
+ mem_tokens = ['<MEM' + str(i) + '>' for i in range(self.n_emb)]
217
+ self.tokenizer.add_special_tokens({'additional_special_tokens': mem_tokens})
218
+ self.tokenizer.mem_tokens = mem_tokens
219
+ self.tokenizer.mem_token_ids = [self.tokenizer.convert_tokens_to_ids(elt) for elt in self.tokenizer.mem_tokens]
220
+ self.tokenizer.mem_token_ids_pt = torch.LongTensor(self.tokenizer.mem_token_ids)
221
+ self.model.resize_token_embeddings(len(self.tokenizer))
222
+
223
+ if self.tokenizer.pad_token_id is None:
224
+ self.tokenizer.pad_token_id = self.tokenizer.bos_token_id
225
+
226
+ if not use_mlp:
227
+ assert decoder_hidden_size == self.hidden_size, f'Mlp mandatory is hidden sizes not equal: {decoder_hidden_size} vs {self.hidden_size}'
228
+
229
+ self.lora = False
230
+ self.lora_name = 'compr_adapter'
231
+
232
+ def prepare_mem_tokens_optimization(self):
233
+ assert self.lora, 'should only be called with lora.'
234
+ self.model.get_input_embeddings().weight.requires_grad = True
235
+ # Applying a hook zero-ing the gradients except for the mem token:
236
+ def hook(grad):
237
+ mask = torch.zeros_like(grad)
238
+ mask[self.tokenizer.mem_token_ids] = 1.0
239
+ return grad * mask
240
+ self.model.get_input_embeddings().weight.register_hook(hook)
241
+
242
+ def set_lora(self, peft_config):
243
+ self.model.add_adapter(peft_config, self.lora_name)
244
+ self.model.set_adapter(self.lora_name)
245
+ self.lora = True
246
+ self.prepare_mem_tokens_optimization()
247
+
248
+ def forward(self, input_ids, attention_mask):
249
+ assert input_ids.size() == attention_mask.size()
250
+ assert len(input_ids.size()) == 2
251
+
252
+ batch_size_times_top_k = input_ids.size(0)
253
+
254
+ last_hidden_states = self.model(input_ids=input_ids,
255
+ attention_mask=attention_mask,
256
+ output_hidden_states=True).hidden_states[-1]
257
+
258
+ # Getting the hidden states at the mem token positions, as for regular cocom:
259
+ mask = torch.isin(input_ids, self.tokenizer.mem_token_ids_pt.to(input_ids.device))
260
+ selected_n_tokens = last_hidden_states[mask].reshape(last_hidden_states.size(0), -1, last_hidden_states.size(-1))
261
+
262
+ assert selected_n_tokens.size() == (batch_size_times_top_k, self.n_emb, self.hidden_size), f"{selected_n_tokens.size()} vs {(batch_size_times_top_k, self.n_emb, self.hidden_size)}"
263
+
264
+ if self.use_mlp:
265
+ selected_n_tokens = self.mlp(selected_n_tokens) # now of shape (batch_size, top_k, decoder_hidden_size)
266
+
267
+ assert selected_n_tokens.size() == (batch_size_times_top_k, self.n_emb, self.decoder_hidden_size), f"{selected_n_tokens.size()} vs {(batch_size_times_top_k, self.n_emb, self.decoder_hidden_size)}"
268
+
269
+ return selected_n_tokens
270
+
271
+ def get_lora_path_from_directory(self, directory):
272
+ return os.path.join(directory, 'compressor_adapters.pth')
273
+
274
+ def get_compressor_path_from_directory(self, directory):
275
+ return os.path.join(directory, 'compressor.pth')
276
+
277
+ def get_mlp_path_from_directory(self, directory):
278
+ return os.path.join(directory, 'mlp.pth')
279
+
280
+ def get_first_layer_path_from_directory(self, directory):
281
+ return os.path.join(directory, 'first_layer.pth')
282
+
283
+ def get_first_layer_state_dict(self) -> dict:
284
+ out = {}
285
+ for k, v in self.model.named_parameters():
286
+ if 'embed_tokens.weight' in k:
287
+ out[k] = v.cpu()
288
+
289
+ assert len(out) == 1, len(out) # We should get exactly one layer here
290
+ return out
291
+
292
+ def save_pretrained(self, save_directory):
293
+ """
294
+ Here we just save mlp state_dict and model state_dict
295
+ Config is handled in cocom model.
296
+ """
297
+ if not os.path.exists(save_directory):
298
+ os.makedirs(save_directory)
299
+
300
+ # Save MLP weights
301
+ if self.use_mlp:
302
+ mlp_path = self.get_mlp_path_from_directory(directory=save_directory)
303
+ torch.save(self.mlp.state_dict(), mlp_path)
304
+
305
+ # Saving the model
306
+ if not self.lora: # full training: save the full dict:
307
+ model_path = self.get_compressor_path_from_directory(directory=save_directory)
308
+ torch.save(self.model.state_dict(), model_path)
309
+ else: # lora training of the compressor
310
+ # We save the first layer:
311
+ first_layer_state_dict = self.get_first_layer_state_dict()
312
+ torch.save(first_layer_state_dict, self.get_first_layer_path_from_directory(directory=save_directory))
313
+
314
+ # We save the adapters:
315
+ adapter_state_dict = {k: v.cpu() for k, v in self.model.get_adapter_state_dict(self.lora_name).items()}
316
+ torch.save(adapter_state_dict, self.get_lora_path_from_directory(directory=save_directory))
317
+
318
+ def load_adapter(self, load_directory, peft_config):
319
+ assert peft_config is not None
320
+ map_location = torch.device("cpu") if not torch.cuda.is_available else None
321
+ adapter_state_dict = torch.load(self.get_lora_path_from_directory(directory=load_directory), map_location=map_location, weights_only=True)
322
+ print('loading compr adapter onto compressor model from', self.get_lora_path_from_directory(directory=load_directory))
323
+ self.model.load_adapter(peft_config=peft_config, adapter_name=self.lora_name, adapter_state_dict=adapter_state_dict)
324
+ self.lora = True
325
+ self.prepare_mem_tokens_optimization()
326
+
327
+ def load_first_layer(self, load_directory):
328
+ map_location = torch.device("cpu") if not torch.cuda.is_available else None
329
+ first_layer_state_dict = torch.load(self.get_first_layer_path_from_directory(load_directory), map_location=map_location, weights_only=True)
330
+ assert len(first_layer_state_dict.keys()) == 1
331
+ self.model.load_state_dict(first_layer_state_dict, strict=False)
332
+
333
+ def load_pretrained(self, load_directory, lora: bool = False, peft_config=None):
334
+ """
335
+ Loading the state dicts.
336
+ :lora: if True then the compressor was trained using lora: we just need to load the adapters
337
+ if False, the compressor was fully trained: we load it fully.
338
+ """
339
+ if self.use_mlp:
340
+ mlp_path = self.get_mlp_path_from_directory(directory=load_directory)
341
+ self.mlp.load_state_dict(torch.load(mlp_path, weights_only=True))
342
+
343
+ if lora:
344
+ self.load_first_layer(load_directory)
345
+ self.load_adapter(load_directory, peft_config)
346
+
347
+ else:
348
+ model_path = self.get_compressor_path_from_directory(directory=load_directory)
349
+ self.model.load_state_dict(torch.load(model_path, weights_only=True))
350
+
351
+ def prepare_inputs(self, texts, max_length, q_texts=None):
352
+ if q_texts is not None: # Query-dependent here:
353
+ assert len(texts) == len(q_texts), f"{len(texts)} == {len(q_texts)}"
354
+ if self.compr_model_name == 'mistral_trimmed':
355
+ # No special token, just formulating:
356
+ texts_to_encode = [ '\nQuery:\n' + query + 'Document:\n' + text for text, query in zip(texts, q_texts)]
357
+ inp_enc = self.tokenizer(texts_to_encode,
358
+ return_tensors='pt',
359
+ padding='max_length',
360
+ max_length=max_length + 8, # some margin for query/doc stuff + bos / eos
361
+ truncation=True,
362
+ add_special_tokens=True)
363
+ else:
364
+ inp_enc = self.tokenizer(q_texts, # we put the query in first position
365
+ texts,
366
+ return_tensors='pt',
367
+ padding='max_length',
368
+ max_length=max_length + 3,
369
+ truncation='only_second',
370
+ add_special_tokens=True)
371
+ else:
372
+ inp_enc = self.tokenizer(texts, return_tensors='pt', padding='max_length', max_length=max_length + 2, truncation=True, add_special_tokens=True)
373
+
374
+ inp_enc['input_ids'], inp_enc['attention_mask'] = add_memory_tokens_to_inputs(inp_enc['input_ids'],
375
+ inp_enc['attention_mask'],
376
+ self.n_emb,
377
+ tokenizer=self.tokenizer)
378
+
379
+ return inp_enc
380
+
381
+
382
+ def add_memory_tokens_to_inputs(input_ids: torch.Tensor, attention_mask: torch.Tensor, n_mem_tokens: int, tokenizer):
383
+ """
384
+ Concatenate the input ids with n_mem_tokens mem_tokens and update the corresponding attention mask
385
+ """
386
+ assert len(tokenizer.mem_tokens) == n_mem_tokens, f"{len(tokenizer.mem_tokens)} VS {n_mem_tokens}"
387
+ mem_tokens = torch.stack([tokenizer.mem_token_ids_pt] * input_ids.size(0), 0)
388
+ assert len(mem_tokens.size()) == 2
389
+ assert len(mem_tokens) == input_ids.size(0)
390
+ assert len(mem_tokens[0]) == n_mem_tokens
391
+ #mem_tokens = torch.full((input_ids.size(0), n_mem_tokens), tokenizer.mem_token_id, dtype=torch.long)
392
+ input_ids = torch.cat([input_ids, mem_tokens], dim=1)
393
+ attention_mask = torch.cat([attention_mask, torch.ones(input_ids.size(0), n_mem_tokens)], dim=1)
394
+ return input_ids, attention_mask
395
+
396
+
397
+ class COCOMConfig(PretrainedConfig):
398
+
399
+ model_type = "COCOM"
400
+ def __init__(self,
401
+ decoder_model_name: str = "meta-llama/Llama-2-7b-chat-hf",
402
+ doc_max_length: int = 128,
403
+ quantization: str = 'no',
404
+ sep: bool = False,
405
+ compr_model_name: str = "google-bert/bert-base-uncased",
406
+ compr_rate: int = 64,
407
+ compr_n_layers: int = None, # only for surgical mistral compressor
408
+ compr_every_n_layer: int = None,
409
+ compr_base_model_name: str = 'mistralai/Mistral-7B-Instruct-v0.2',
410
+ compr_rms_norm: bool = False, # only for surgical mistral compressor: if true, rms norm applied on h-s
411
+ compr_mlp_hidden_dim: int = 8096,
412
+ compr_use_mlp: bool = True,
413
+ lora: bool = False, # lora on decoder (and decoder as compr)
414
+ lora_compressor: bool = False, # lora only on the compressor if it exists
415
+ training_form: str = "both",
416
+ lora_r: int = 16,
417
+ lora_r_compressor: int = None,
418
+ load_adapters: bool = True,
419
+ kbtc_training: bool = False,
420
+ optimize_mem_tokens: bool = False,
421
+ different_mem_tokens: bool = False,
422
+ attn_implementation: str = 'flash_attention_2',
423
+ device_map = None,
424
+ **kwargs):
425
+ super().__init__(**kwargs)
426
+
427
+ self.decoder_model_name = decoder_model_name # model name of decoder
428
+ self.doc_max_length = doc_max_length # the maximum length of document that can be used by this model (it is used to compute number of mem tokens !)
429
+ self.quantization = quantization # quantization, could be no, int4, int8
430
+ self.sep = sep # boolean type, whether to use sep token
431
+
432
+ self.compr_model_name = compr_model_name # model name of compressor
433
+ self.compr_rate = compr_rate # compression rate
434
+ self.compr_use_mlp = compr_use_mlp
435
+ self.compr_mlp_hidden_dim = compr_mlp_hidden_dim
436
+ self.compr_n_layers = compr_n_layers
437
+ self.compr_every_n_layer = compr_every_n_layer
438
+ self.compr_base_model_name = compr_base_model_name
439
+ self.compr_rms_norm = compr_rms_norm
440
+
441
+ self.lora = lora # boolean type, whether to use lora trsining
442
+ self.lora_compressor = lora_compressor
443
+ self.training_form = training_form # training form, could be compressor: training only comprssor; both: training both
444
+ # Or both_separately: training both with separate adapters
445
+ self.lora_r = lora_r # lora_r for lora training, we use 16 throughout the experiment.
446
+ self.lora_r_compressor = lora_r_compressor or lora_r # defaulting to same lora as decoder.
447
+ self.load_adapters = load_adapters # used to load pretrained model: we first load without adapters, and then load them from file.
448
+ self.optimize_mem_tokens = optimize_mem_tokens
449
+ self.different_mem_tokens = different_mem_tokens
450
+
451
+ self.kbtc_training = kbtc_training
452
+
453
+ self.device_map = device_map
454
+
455
+ self.attn_implementation = attn_implementation
456
+
457
+ if training_form == 'compressor':
458
+ assert compr_model_name is not None and not self.lora
459
+
460
+
461
+ class COCOM(PreTrainedModel):
462
+ config_class = COCOMConfig
463
+ def __init__(self, cfg):
464
+ super().__init__(cfg)
465
+ self.decoder_model_name = cfg.decoder_model_name
466
+ self.decoder = self.create_decoder(cfg)
467
+
468
+ self.doc_max_length = cfg.doc_max_length
469
+
470
+ print('Base decoder nb parameters', self.decoder.num_parameters())
471
+
472
+ self.compr_model_name = cfg.compr_model_name
473
+ self.training_form = cfg.training_form
474
+ self.lora = cfg.lora
475
+ self.adapter_keys = []
476
+
477
+ self.compr = None
478
+ # when compr_model_name is not set, then means using a decoder-based compressor, otherwise a bert based compressor
479
+ if cfg.compr_model_name is not None:
480
+ # case bert based compressor
481
+ print('Instantiating compressor ', cfg.compr_model_name)
482
+ self.compr = BertCompressor(cfg.compr_model_name,
483
+ cfg.compr_rate,
484
+ doc_max_length=self.doc_max_length,
485
+ decoder_hidden_size=self.decoder.config.hidden_size,
486
+ mlp_hidden_dim=cfg.compr_mlp_hidden_dim,
487
+ compr_n_layers=cfg.compr_n_layers,
488
+ compr_every_n_layer=cfg.compr_every_n_layer,
489
+ compr_base_model_name=cfg.compr_base_model_name,
490
+ compr_rms_norm=cfg.compr_rms_norm,
491
+ use_mlp=cfg.compr_use_mlp,
492
+ attn_implementation=cfg.attn_implementation)
493
+
494
+ # set lora adaptors on decoder model
495
+ if cfg.lora:
496
+ peft_config = self.get_peft_config(lora_r=cfg.lora_r)
497
+
498
+ if cfg.load_adapters:
499
+ self.decoder.add_adapter(peft_config, 'decoder_adapter')
500
+ self.decoder.set_adapter('decoder_adapter') # active adapter by default
501
+ self.adapter_keys.append('decoder_adapter')
502
+
503
+ # Create separate adapters (if not BERT compressor and training_form == 'both_separately')
504
+ if self.training_form == 'both_separately' and self.compr is None:
505
+ if cfg.load_adapters:
506
+ self.decoder.add_adapter(peft_config, 'encoder_adapter')
507
+ self.adapter_keys.append('encoder_adapter')
508
+
509
+ # set lora adapters on compressor model:
510
+ if cfg.lora_compressor and self.compr is not None and cfg.load_adapters:
511
+ peft_config = self.get_peft_config(lora_r=cfg.lora_r_compressor)
512
+ self.compr.set_lora(peft_config)
513
+
514
+ self.decoder_tokenizer = COCOM.create_decoder_tokenizer(cfg)
515
+
516
+ # resize the tokenizer embedding
517
+ self.decoder.resize_token_embeddings(len(self.decoder_tokenizer))
518
+ self.decoder.generation_config.top_p = None
519
+ self.decoder.generation_config.temperature = None
520
+ self.decoder.generation_config.pad_token_id = self.decoder_tokenizer.pad_token_id
521
+
522
+ # self.decoder.gradient_checkpointing_enable()
523
+ # if self.compr is not None:
524
+ # self.compr.gradient_checkpointing_enable()
525
+
526
+ # other settings
527
+ self.generation_top_k = 1
528
+ self.sep = cfg.sep
529
+ self.compr_rate = cfg.compr_rate
530
+ self.local_rank = os.getenv('LOCAL_RANK', '0')
531
+
532
+ self.n_mem_tokens = self.doc_max_length // self.compr_rate # crucial!
533
+
534
+
535
+ if self.lora:
536
+ for adapter_key in self.adapter_keys:
537
+ self.decoder.set_adapter(adapter_key)
538
+ print(f'Adapter {adapter_key} trainable parameters: {self.num_parameters(only_trainable=True)}')
539
+
540
+ # We need to activate all adapters so that they are both trained...
541
+ self.set_all_adapters()
542
+ else:
543
+ print(f'Total trainable parameters: {self.num_parameters(only_trainable=True)}')
544
+
545
+ if self.compr is not None:
546
+ print(f'Compressor number of parameters: {self.compr.model.num_parameters(only_trainable=True)}')
547
+
548
+ self.prepare_mem_tokens_optimization()
549
+
550
+ def prepare_mem_tokens_optimization(self):
551
+ if self.config.optimize_mem_tokens:
552
+ if self.compr is None:
553
+ # Enforcing gradients for input embeddings (even if lora)
554
+ self.decoder.get_input_embeddings().weight.requires_grad = True
555
+ # Applying a hook zero-ing the gradients except for the mem token:
556
+ def hook(grad):
557
+ mask = torch.zeros_like(grad)
558
+ mask[self.decoder_tokenizer.mem_token_ids] = 1.0
559
+ return grad * mask
560
+ self.decoder.get_input_embeddings().weight.register_hook(hook)
561
+
562
+ def set_all_adapters(self):
563
+ if len(self.adapter_keys) > 0:
564
+ self.decoder.set_adapter(self.adapter_keys)
565
+
566
+ @staticmethod
567
+ def create_decoder_tokenizer(cfg: COCOMConfig):
568
+ decoder_tokenizer = AutoTokenizer.from_pretrained(cfg.decoder_model_name, use_fast=True, padding_side='left')
569
+
570
+ # define special tokens
571
+ n_mem_tokens = cfg.doc_max_length // cfg.compr_rate
572
+ if cfg.different_mem_tokens:
573
+ # estimation fo the number of memory tokens needed:
574
+ mem_tokens = ['<MEM' + str(i) + '>' for i in range(n_mem_tokens)]
575
+ decoder_tokenizer.add_special_tokens({'additional_special_tokens': mem_tokens + ['<AE>', '<ENC>', '<SEP>']})
576
+ decoder_tokenizer.mem_tokens = mem_tokens
577
+ else:
578
+ decoder_tokenizer.add_special_tokens({'additional_special_tokens': ['<MEM>', '<AE>', '<ENC>', '<SEP>']})
579
+ decoder_tokenizer.mem_tokens = ['<MEM>'] * n_mem_tokens
580
+
581
+ decoder_tokenizer.mem_token_ids = [decoder_tokenizer.convert_tokens_to_ids(elt) for elt in decoder_tokenizer.mem_tokens]
582
+ decoder_tokenizer.mem_token_ids_pt = torch.LongTensor(decoder_tokenizer.mem_token_ids) # required later on for operations on tensors
583
+
584
+ decoder_tokenizer.ae_token = '<AE>' # token for autoencoding on decoder side
585
+ decoder_tokenizer.ae_token_id = decoder_tokenizer.convert_tokens_to_ids('<AE>')
586
+ decoder_tokenizer.enc_token = '<ENC>' # token for autoencoding on compressor side
587
+ decoder_tokenizer.sep_token = '<SEP>' # sep token between document
588
+ decoder_tokenizer.sep_token_id = decoder_tokenizer.convert_tokens_to_ids('<SEP>')
589
+
590
+ # If kbtc training, we add another one yet
591
+ if cfg.kbtc_training:
592
+ decoder_tokenizer.add_special_tokens({'additional_special_tokens': ['<KBTC>']})
593
+ decoder_tokenizer.kbtc_token = '<KBTC>'
594
+ decoder_tokenizer.kbtc_token_id = decoder_tokenizer.convert_tokens_to_ids('<KBTC>')
595
+
596
+ # if pad token exists then use pad token, othrwise bos token
597
+ if decoder_tokenizer.pad_token_id is None:
598
+ decoder_tokenizer.pad_token_id = decoder_tokenizer.bos_token_id
599
+
600
+ return decoder_tokenizer
601
+
602
+ def get_peft_config(self, lora_r: int) -> LoraConfig:
603
+ """
604
+ Builds the peft config
605
+ """
606
+ return LoraConfig(task_type="CAUSAL_LM", r=lora_r, lora_alpha=2*lora_r, target_modules='all-linear', lora_dropout=0.1)
607
+
608
+ def create_decoder(self, cfg):
609
+ """
610
+ Loads the base decoder.
611
+ """
612
+ if torch.cuda.is_available():
613
+ if cfg.quantization == "no":
614
+ return AutoModelForCausalLM.from_pretrained(
615
+ cfg.decoder_model_name,
616
+ torch_dtype=torch.bfloat16,
617
+ attn_implementation=self.config.attn_implementation,
618
+ # low_cpu_mem_usage = True,
619
+ device_map=cfg.device_map
620
+ )
621
+ elif cfg.quantization == "int4":
622
+ quant_config = BitsAndBytesConfig(
623
+ load_in_4bit=True,
624
+ bnb_4bit_quant_type='nf4',
625
+ bnb_4bit_compute_dtype='bfloat16',
626
+ # low_cpu_mem_usage = True,
627
+ )
628
+ return AutoModelForCausalLM.from_pretrained(
629
+ cfg.decoder_model_name,
630
+ quantization_config=quant_config,
631
+ attn_implementation=self.config.attn_implementation,
632
+ torch_dtype=torch.bfloat16,
633
+ resume_download=True,
634
+ # low_cpu_mem_usage = True,
635
+ trust_remote_code=True,
636
+ device_map=cfg.device_map
637
+ )
638
+ elif cfg.quantization == "int8":
639
+ quant_config = BitsAndBytesConfig(
640
+ load_in_8bit=True,
641
+ llm_int8_enable_fp32_cpu_offload=True,
642
+ bnb_4bit_compute_dtype='bfloat16',
643
+ # low_cpu_mem_usage = True,
644
+ )
645
+ return AutoModelForCausalLM.from_pretrained(
646
+ cfg.decoder_model_name,
647
+ quantization_config=quant_config,
648
+ attn_implementation=self.config.attn_implementation,
649
+ torch_dtype=torch.bfloat16,
650
+ resume_download=True,
651
+ # low_cpu_mem_usage = True,
652
+ trust_remote_code=True,
653
+ device_map=cfg.device_map
654
+ )
655
+ else:
656
+ raise NotImplementedError()
657
+ else:
658
+ return AutoModelForCausalLM.from_pretrained(
659
+ cfg.decoder_model_name,
660
+ torch_dtype=torch.bfloat16,
661
+ resume_download=True,
662
+ # low_cpu_mem_usage = True,
663
+ trust_remote_code=True,
664
+ device_map=cfg.device_map
665
+ )
666
+
667
+ def compress(self, enc_input_ids, enc_attention_mask):
668
+ if self.compr:
669
+ return self.compr(enc_input_ids, enc_attention_mask)
670
+ else:
671
+ return self.compr_decoder(enc_input_ids, enc_attention_mask)
672
+
673
+ def replace_emb(self, compressed_embs, dec_input_ids):
674
+ """
675
+ Compression logic (either with decoder or with dedicated compressor)
676
+ """
677
+ indices = range(0, compressed_embs.size(0) + 1, self.generation_top_k)
678
+ input_embeds = self.replace_embeddings(compressed_embs, dec_input_ids, indices)
679
+ return input_embeds
680
+
681
+ def compr_decoder(self, input_ids, attention_mask):
682
+ """
683
+ Compression using the decoder
684
+ """
685
+ assert input_ids.size() == attention_mask.size(), f"{input_ids.size()} vs {attention_mask.size()}"
686
+
687
+ # Switch adapter if we are training two different ones:
688
+ if 'encoder_adapter' in self.adapter_keys:
689
+ self.decoder.set_adapter('encoder_adapter')
690
+
691
+ emb = self.decoder(input_ids=input_ids,
692
+ attention_mask=attention_mask,
693
+ output_hidden_states=True).hidden_states[-1]
694
+ mask = torch.isin(input_ids, self.decoder_tokenizer.mem_token_ids_pt.to(input_ids.device))
695
+ return emb[mask].reshape(emb.size(0), -1, emb.size(-1))
696
+
697
+ def prepare_encoder_inputs_to_decoder(self, texts, max_length, q_texts=None):
698
+ if q_texts is not None:
699
+ texts_to_encode = [self.decoder_tokenizer.enc_token + self.decoder_tokenizer.bos_token + '\nQuery:\n' + query + 'Document:\n' + text + self.decoder_tokenizer.eos_token
700
+ for text, query in zip(texts, q_texts)]
701
+ inp_enc = self.decoder_tokenizer(texts_to_encode, return_tensors='pt', padding='max_length', max_length=max_length + 8, truncation=True, add_special_tokens=False)
702
+ else:
703
+ inp_enc = [self.decoder_tokenizer.enc_token + self.decoder_tokenizer.bos_token + text + self.decoder_tokenizer.eos_token for text in texts]
704
+ inp_enc = self.decoder_tokenizer(inp_enc, return_tensors='pt', padding="max_length", max_length=max_length+3, truncation=True, add_special_tokens=False)
705
+
706
+ num_mem_tokens = self.doc_max_length // self.compr_rate
707
+ assert num_mem_tokens == len(self.decoder_tokenizer.mem_tokens)
708
+ inp_enc['input_ids'], inp_enc['attention_mask'] = add_memory_tokens_to_inputs(inp_enc['input_ids'],
709
+ inp_enc['attention_mask'],
710
+ num_mem_tokens,
711
+ tokenizer=self.decoder_tokenizer)
712
+
713
+ return inp_enc
714
+
715
+ def prepare_encoder_inputs(self, texts: list[str], max_length: int, q_texts: list[str] = None):
716
+ """
717
+ Create the inputs to the encoder, for compression.
718
+ """
719
+ if q_texts is not None:
720
+ assert len(texts) == len(q_texts), f"{len(texts)} == {len(q_texts)}"
721
+
722
+ # Case where the encoder is the decoder with adapter:
723
+ if self.compr is None:
724
+ return self.prepare_encoder_inputs_to_decoder(texts, max_length, q_texts)
725
+
726
+ # Case where the encoder is a separate network:
727
+ else:
728
+ return self.compr.prepare_inputs(texts, max_length, q_texts)
729
+
730
+ def replace_embeddings(self, compressed_embs, dec_input_ids, indices):
731
+ """
732
+ Replace memory tokens in the decoder input to with the compressed embeddings
733
+ """
734
+ inputs_embeds = self.decoder.get_input_embeddings()(dec_input_ids)
735
+ num_embs = compressed_embs.size(1)
736
+ if self.sep:
737
+ slot_len = num_embs + 1
738
+ else:
739
+ slot_len = num_embs
740
+ # get first mem_token indices
741
+ first_mem_token_indices = torch.argmax((dec_input_ids == self.decoder_tokenizer.mem_token_ids[0]).int(), dim=1)
742
+ batch_size = inputs_embeds.size(0)
743
+ # for each example in batch, replace them with compressed embeddings
744
+ for i in range(batch_size):
745
+ for j in range(indices[i], indices[i + 1]):
746
+ start_idx = first_mem_token_indices[i].item() + (j-indices[i]) * slot_len
747
+ assert inputs_embeds[i, start_idx:start_idx + num_embs, :].size() == compressed_embs[j].size(), \
748
+ f"{inputs_embeds[i, start_idx:start_idx + num_embs, :].size()} VS {compressed_embs[j].size()}"
749
+ inputs_embeds[i, start_idx:start_idx + num_embs, :] = compressed_embs[j]
750
+ return inputs_embeds
751
+
752
+ def forward(self,
753
+ enc_input_ids: torch.LongTensor = None,
754
+ enc_attention_mask: torch.LongTensor = None,
755
+ dec_input_ids: torch.LongTensor = None,
756
+ dec_attention_mask: torch.LongTensor = None,
757
+ labels: torch.LongTensor = None):
758
+ """
759
+ enc_input_ids: stores the contexts, should be flattened from all queries before input, can be of shape:
760
+ - (batch_size*generation_top_k, enc_token_length)
761
+ - (batch_size, generation_top_k, enc_token_length)
762
+ enc_attention_mask: attention mask of enc_input_ids, same shape as enc_input_ids
763
+ dec_input_ids: stores the prompts (including mem tokens), dimention (batch_size, dec_token_length)
764
+ dec_attention_mask: attention mask of dec_input_ids
765
+ """
766
+ assert enc_input_ids.size() == enc_attention_mask.size(), f"{enc_input_ids.size()} vs {enc_attention_mask.size()}"
767
+
768
+ if len(enc_input_ids.size()) == 3: # likely from bergen: we just flatten all of this to perform encoding in one batch
769
+ batch_size, top_k, seq_length = enc_input_ids.size()
770
+ enc_input_ids = enc_input_ids.view(batch_size * top_k, seq_length)
771
+ enc_attention_mask = enc_attention_mask.view(batch_size * top_k, seq_length)
772
+
773
+ # Here, we should have top_k times more elements in enc_input_ids than in dec_input_ids
774
+ assert enc_input_ids.size(0) == dec_input_ids.size(0) * self.generation_top_k, \
775
+ f"{enc_input_ids.size(0)} VS {dec_input_ids.size(0)} with generation_top_k={self.generation_top_k}"
776
+
777
+ # Perform compression with gradient tracking
778
+ compressed_embs = self.compress(enc_input_ids, enc_attention_mask)
779
+ inputs_embeds = self.replace_emb(compressed_embs, dec_input_ids)
780
+
781
+ # if training_form is compressor, then detach the inputs_embeds, to make gradient not count in decoder
782
+ if (self.training_form == "compressor") and (self.compr is None):
783
+ inputs_embeds = inputs_embeds.detach()
784
+
785
+ # decoding
786
+ if 'decoder_adapter' in self.adapter_keys:
787
+ self.decoder.set_adapter('decoder_adapter')
788
+
789
+ decoder_outputs = self.decoder(inputs_embeds=inputs_embeds, attention_mask=dec_attention_mask, labels=labels)
790
+
791
+ # At end of forward, we need to activate all adapters so that they are both trained...
792
+ self.set_all_adapters()
793
+
794
+ return {"loss": decoder_outputs.loss, "logits": decoder_outputs.logits}
795
+
796
+ def generate(self, model_input, max_new_tokens=128, return_doc_embeddings: bool = False):
797
+
798
+ enc_input_ids, enc_attention_mask, dec_input_ids, dec_attention_mask = model_input['enc_input_ids'], model_input['enc_attention_mask'], model_input['dec_input_ids'], model_input['dec_attention_mask']
799
+
800
+ assert enc_input_ids.size() == enc_attention_mask.size()
801
+
802
+ if len(enc_input_ids.size()) == 3: # likely from bergen: we just flatten all of this to perform encoding in one batch
803
+ batch_size, top_k, seq_length = enc_input_ids.size()
804
+ enc_input_ids = enc_input_ids.view(batch_size * top_k, seq_length)
805
+ enc_attention_mask = enc_attention_mask.view(batch_size * top_k, seq_length)
806
+
807
+ # Here, we should have top_k times more elements in enc_input_ids than in dec_input_ids
808
+ assert enc_input_ids.size(0) == dec_input_ids.size(0) * self.generation_top_k, \
809
+ f"{enc_input_ids.size(0)} VS {dec_input_ids.size(0)} with generation_top_k={self.generation_top_k}"
810
+
811
+ compressed_embs = self.compress(enc_input_ids.to('cuda'), enc_attention_mask.to('cuda'))
812
+ inputs_embeds = self.replace_emb(compressed_embs, dec_input_ids.to('cuda'))
813
+
814
+ # Switch adapter if we are training two different ones:
815
+ if 'decoder_adapter' in self.adapter_keys:
816
+ self.decoder.set_adapter('decoder_adapter')
817
+
818
+ output_ids = self.decoder.generate(
819
+ inputs_embeds=inputs_embeds.to("cuda"),
820
+ attention_mask=dec_attention_mask.to("cuda"),
821
+ do_sample=False,
822
+ top_p=None,
823
+ max_new_tokens=max_new_tokens
824
+ )
825
+
826
+ decoded = self.decoder_tokenizer.batch_decode(output_ids, skip_special_tokens=True)
827
+
828
+ if return_doc_embeddings:
829
+ # Compressed_embds is of shape (batch_size*top_k, n_mem_tokens, hidden_dim)
830
+ # We reshape to batch_size, top_k, n_mem_tokens, hidden_dim
831
+ assert batch_size is not None
832
+ assert top_k is not None
833
+ compressed_embs = compressed_embs.view(batch_size, top_k, compressed_embs.size(1), compressed_embs.size(2))
834
+ return decoded, compressed_embs
835
+ else:
836
+ return decoded
837
+
838
+ def get_all_adapters_state_dict(self):
839
+ """
840
+ Return the state dicts of the adapters
841
+ Used for saving so we go to cpu automatically
842
+ """
843
+ return {key: {k:v.cpu() for k, v in self.decoder.get_adapter_state_dict(key).items()} for key in self.adapter_keys}
844
+
845
+ def load_adapter_from_state_dict(self, peft_config: LoraConfig, adapter_name: str, adapter_state_dict: dict) -> None:
846
+ """
847
+ Creates an adapter from the state dict (used to load from pretrained)
848
+ """
849
+ # assert adapter_name not in self.adapter_keys, f'Adapter {adapter_name} already exists'
850
+ print(f'loading adapter {adapter_name}')
851
+ self.decoder.load_adapter(peft_config=peft_config, adapter_name=adapter_name, adapter_state_dict=adapter_state_dict)
852
+ self.adapter_keys.append(adapter_name)
853
+
854
+ def get_decoder_first_and_last_layer_state_dict(self) -> dict:
855
+ """
856
+ Just getting the first and last layers: the only ones which change when adding tokens
857
+ Used to save the model so we automatically move to cpu.
858
+ """
859
+ out = {}
860
+ for k, v in self.decoder.named_parameters():
861
+ if 'lm_head.weight' in k or 'embed_tokens.weight' in k:
862
+ out[k] = v.cpu()
863
+
864
+ # assert len(out) == 2, len(out) # We should get both the embedding layer and the head layer.
865
+ return out
866
+
867
+ def save_pretrained(self, save_directory: str, **kwargs):
868
+ """
869
+ Save only the LoRA adapters and their configurations.
870
+ """
871
+ if self.lora:
872
+ if not os.path.exists(save_directory):
873
+ os.makedirs(save_directory)
874
+
875
+ # Save the LoRA adapter weights
876
+ torch.save(self.get_all_adapters_state_dict(), os.path.join(save_directory, "adapters.pth"))
877
+
878
+ # Save the first and last layers of decoder (because of diffs with tokens !)
879
+ torch.save(self.get_decoder_first_and_last_layer_state_dict(), os.path.join(save_directory, "decoder_first_last_layers.pth"))
880
+
881
+ # Save the bert compressor if it exists
882
+ if self.compr_model_name is not None:
883
+ self.compr.save_pretrained(os.path.join(save_directory, 'compressor'))
884
+
885
+ # Save the configuration
886
+ self.config.save_pretrained(save_directory)
887
+ else:
888
+ super().save_pretrained(save_directory, **kwargs)
889
+
890
+ @classmethod
891
+ def from_pretrained(cls, pretrained_model_name_or_path, *args, **kwargs):
892
+ """
893
+ Loading: to take care of checkpoints containing only lora and not base model.
894
+ """
895
+ # Load the configuration
896
+ config = COCOMConfig.from_pretrained(pretrained_model_name_or_path)
897
+
898
+ config.attn_implementation = kwargs.get('attn_implementation', config.attn_implementation)
899
+
900
+ map_location = torch.device("cpu") if not torch.cuda.is_available() else None
901
+
902
+ if config.lora:
903
+ # We need to delay the construction of the adapters (otherwise peft complains)
904
+ config.load_adapters = False
905
+
906
+ if 'device_map' in kwargs:
907
+ config.device_map = kwargs['device_map']
908
+
909
+ # Initialize the model
910
+ model = cls(config)
911
+
912
+ # Loading first and last layers (they might have changed due to extra tokens)
913
+ first_and_last_layers_path = os.path.join(pretrained_model_name_or_path, 'decoder_first_last_layers.pth')
914
+ if os.path.exists(first_and_last_layers_path):
915
+ first_and_last_decoder_state_dict = torch.load(first_and_last_layers_path, map_location=map_location, weights_only=True)
916
+ for key in first_and_last_decoder_state_dict:
917
+ assert key in model.decoder.state_dict()
918
+ try:
919
+ model.decoder.load_state_dict(first_and_last_decoder_state_dict, strict=False)
920
+ except RuntimeError as e:
921
+ # Sometimes we get an error: for non-query dependent models saved with a query_dependent token: we add it now.
922
+ if "size mismatch for" in str(e):
923
+ warnings.warn('Mismatch when loading embedding/head: it may be because of a lack of query_dependent token for some models\
924
+ I add it and retry now.')
925
+ print('Adding special token!')
926
+ model.tokenizer.add_special_tokens({'additional_special_tokens': ['<SEPQD>']})
927
+ model.tokenizer.sepqd_token = '<SEPQD>'
928
+ model.tokenizer.sepqd_token_id = model.tokenizer.convert_tokens_to_ids('<SEPQD>')
929
+ model.decoder.resize_token_embeddings(len(model.decoder_tokenizer))
930
+ model.decoder.load_state_dict(first_and_last_decoder_state_dict, strict=False)
931
+ else:
932
+ raise
933
+ else:
934
+ print('FIRST AND LAST LAYER NOT FOUND (ok for some old models):', first_and_last_layers_path)
935
+
936
+ peft_config = model.get_peft_config(lora_r=config.lora_r)
937
+
938
+ # Load the LoRA adapters (if the file exists)
939
+ adapters_path = os.path.join(pretrained_model_name_or_path, "adapters.pth")
940
+ if os.path.exists(adapters_path):
941
+ adapters_state_dict = torch.load(adapters_path, map_location=map_location, weights_only=True)
942
+
943
+ for key, val in adapters_state_dict.items():
944
+ model.load_adapter_from_state_dict(peft_config=peft_config, adapter_name=key, adapter_state_dict=val)
945
+
946
+ else:
947
+ warnings.warn('I see lora on that PISCO model, but {adapters_path} does not exist, it may be normal \
948
+ for recent versions of transformers, be aware.')
949
+
950
+ # If there is a compressor, it's been built: we just need to load the state dict or the adapters:
951
+ if config.compr_model_name is not None:
952
+ model.compr.load_pretrained(os.path.join(pretrained_model_name_or_path, 'compressor'),
953
+ lora=config.lora_compressor,
954
+ peft_config=model.get_peft_config(lora_r=config.lora_r_compressor))
955
+
956
+ model.set_all_adapters()
957
+ model.config.load_adapters = True
958
+ return model
959
+
960
+ else:
961
+ return super().from_pretrained(pretrained_model_name_or_path, **kwargs)
962
+
963
+ def generate_from_text(self, questions: list[str], documents: list[list[str]], max_new_tokens: int = 128) -> list[str]:
964
+ """
965
+ Generates answers from documents (via compression then decoding)
966
+ questions: list of string
967
+ documents: list of list of strings (they should all be of equal length: the nb of doc for each question)
968
+ """
969
+ self.generation_top_k = len(documents[0])
970
+ assert len(documents) == len(questions)
971
+ assert all([len(context) == len(documents[0]) for context in documents])
972
+ flat_documents = sum(documents, [])
973
+
974
+ model_input = {}
975
+
976
+ # Creating encoder inputs:
977
+ input_encoder = self.prepare_encoder_inputs(flat_documents, max_length=128)
978
+ device = self.decoder.device
979
+ model_input['enc_input_ids'], model_input['enc_attention_mask'] = input_encoder['input_ids'].to(device), input_encoder['attention_mask'].to(device)
980
+
981
+ # Creating decoder inputs
982
+ instr = [self.blend_prompt_and_memory_tokens(query=q) for q in questions]
983
+ inp_dec = self.decoder_tokenizer(instr, return_tensors='pt', padding="longest", add_special_tokens=False, truncation=True, max_length=2048)
984
+ model_input['dec_input_ids'], model_input['dec_attention_mask'] = inp_dec['input_ids'].to(device), inp_dec['attention_mask'].to(device)
985
+
986
+ # Generation
987
+ return self.generate(model_input, max_new_tokens=max_new_tokens)
988
+
989
+ def generate_from_compressed_documents_and_questions(self, questions: list[str], compressed_documents: torch.Tensor, max_new_tokens: int = 128) -> list[str]:
990
+ """
991
+ Generates answers from compressed documents
992
+ questions: list of string
993
+ compressed_documents: torch tensor, its first dimension should be a multiple of len(questions)
994
+ """
995
+ print(compressed_documents.size(), len(questions))
996
+ self.generation_top_k = compressed_documents.size(0) // len(questions)
997
+ assert compressed_documents.size(0) % self.generation_top_k == 0, f"{compressed_documents.size(0)} {self.generation_top_k}"
998
+
999
+ # Creating decoder inputs
1000
+ instr = [self.blend_prompt_and_memory_tokens(query=q) for q in questions]
1001
+ inp_dec = self.decoder_tokenizer(instr, return_tensors='pt', padding="longest", add_special_tokens=False, truncation=True, max_length=2048)
1002
+ device = self.decoder.device
1003
+ dec_input_ids, dec_attention_mask = inp_dec['input_ids'].to(device), inp_dec['attention_mask'].to(device)
1004
+
1005
+ # Creating input decoder embeddings from prompt + compressed documents
1006
+ inputs_embeds = self.replace_emb(compressed_documents, dec_input_ids)
1007
+
1008
+ # Activating decoder generator:
1009
+ if 'decoder_adapter' in self.adapter_keys:
1010
+ self.decoder.set_adapter('decoder_adapter')
1011
+
1012
+ output_ids = self.decoder.generate(
1013
+ inputs_embeds=inputs_embeds,
1014
+ attention_mask=dec_attention_mask,
1015
+ generation_config=self.generation_config,
1016
+ max_new_tokens=max_new_tokens
1017
+ )
1018
+
1019
+ # de-tokenizing
1020
+ return self.decoder_tokenizer.batch_decode(output_ids, skip_special_tokens=True)
1021
+
1022
+ def compress_documents(self, documents: list[str]) -> torch.Tensor:
1023
+ """
1024
+ Compress a list of documents
1025
+ """
1026
+ input_encoder = self.prepare_encoder_inputs(documents, max_length=128)
1027
+ enc_input_ids = input_encoder['input_ids'].to(self.decoder.device)
1028
+ attention_mask = input_encoder['attention_mask'].to(self.decoder.device)
1029
+ return self.compress(enc_input_ids=enc_input_ids, enc_attention_mask=attention_mask)
1030
+
1031
+ def blend_prompt_and_memory_tokens(self, query: str):
1032
+ """
1033
+ Takes care of blending the prompt with the memory tokens:
1034
+ Also returns, if a label is provided, the position of the first token index of the label (for loss comp later on)
1035
+ (Used for the HUB version)
1036
+ """
1037
+ mem_tokens_str = ''.join(self.decoder_tokenizer.mem_tokens) + self.decoder_tokenizer.sep_token
1038
+
1039
+ # proper names for "eval" call, don't remove these lines
1040
+ docs = mem_tokens_str * self.generation_top_k
1041
+ question = query
1042
+
1043
+ prompt_system = 'You are a helpful assistant. Your task is to extract relevant information from provided documents and to answer to questions as briefly as possible.'
1044
+ prompt_user = f"Background:\n{docs}\n\nQuestion:{question}"
1045
+
1046
+ # Prepare the messages with system and user roles
1047
+ messages = [
1048
+ {"role": "system", "content": prompt_system},
1049
+ {"role": "user", "content": prompt_user.replace(':\ ', ': ')}
1050
+ ]
1051
+
1052
+ # Attempt to apply the system role and catch if it's not supported
1053
+ try:
1054
+ prompt = self.decoder_tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
1055
+
1056
+ except TemplateError as e:
1057
+ # Catch the error related to system role and handle it (e.g. gemma)
1058
+ if "System role not supported" in str(e):
1059
+ # Remove system role and proceed with only the user role
1060
+ messages = [{"role": "user", "content": messages[0]['content'] + '\n' + messages[1]['content']}]
1061
+ # Apply template again without system role
1062
+ prompt = self.decoder_tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
1063
+ else:
1064
+ # Re-raise the exception if it's unrelated to system role
1065
+ raise e
1066
+
1067
+ return prompt
1068
+
1069
+
1070
+ if __name__ == '__main__':
1071
+ cfg = COCOMConfig(decoder_model_name='mistralai/Mistral-7B-Instruct-v0.2',
1072
+ compr_model_name = "mistral_trimmed",
1073
+ compr_rate = 64,
1074
+ compr_n_layers = 5,
1075
+ compr_mlp_hidden_dim = 8096,
1076
+ compr_use_mlp = False,
1077
+ lora = True, # lora on decoder (and decoder as compr)
1078
+ lora_compressor = True, # lora only on the compressor if it exists
1079
+ training_form = "both",
1080
+ load_adapters = True,
1081
+ kbtc_training = False,
1082
+ optimize_mem_tokens = True,
1083
+ different_mem_tokens = True,
1084
+ attn_implementation = 'flash_attention_2')
1085
+
1086
+ cocom = COCOM(cfg)
1087
+
1088
+ cocom.save_pretrained('test_ckpt')
1089
+
1090
+ del cocom
1091
+ torch.cuda.empty_cache()
1092
+ import gc
1093
+ gc.collect()
1094
+
1095
+ cocom = COCOM.from_pretrained('test_ckpt')