Instructions to use Synthyra/FastESM2_650 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use Synthyra/FastESM2_650 with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("fill-mask", model="Synthyra/FastESM2_650", trust_remote_code=True)# Load model directly from transformers import AutoModelForMaskedLM model = AutoModelForMaskedLM.from_pretrained("Synthyra/FastESM2_650", trust_remote_code=True, dtype="auto") - Notebooks
- Google Colab
- Kaggle
| from __future__ import annotations | |
| import torch | |
| import torch._inductor.config as inductor_config | |
| import torch._dynamo as dynamo | |
| # Enable TensorFloat32 tensor cores for float32 matmul (Ampere+ GPUs) | |
| # Provides significant speedup with minimal precision loss | |
| torch.set_float32_matmul_precision('high') | |
| # Enable TF32 for matrix multiplications and cuDNN operations | |
| torch.backends.cuda.matmul.allow_tf32 = True | |
| torch.backends.cudnn.allow_tf32 = True | |
| # Enable cuDNN autotuner - finds fastest algorithms for your hardware | |
| # Best when input sizes are consistent; may slow down first iterations | |
| torch.backends.cudnn.benchmark = True | |
| # Deterministic operations off for speed (set True if reproducibility needed) | |
| torch.backends.cudnn.deterministic = False | |
| inductor_config.max_autotune_gemm_backends = "ATEN,CUTLASS,FBGEMM" | |
| dynamo.config.capture_scalar_outputs = True | |
| torch._dynamo.config.recompile_limit = 16 | |
| import io | |
| import os | |
| import queue | |
| import sqlite3 | |
| import struct | |
| import threading | |
| import time | |
| import networkx as nx | |
| import numpy as np | |
| import torch | |
| from tqdm.auto import tqdm | |
| from typing import Any, Callable, Dict, Iterator, List, Optional, Set, Tuple | |
| from torch.utils.data import DataLoader | |
| from torch.utils.data import Dataset as TorchDataset | |
| from transformers import PreTrainedTokenizerBase | |
| # SQLite stores tensors as compact blobs. Keep this header format compatible | |
| # with Protify readers that share the same dtype/version codes. | |
| _COMPACT_VERSION = 0x01 | |
| _DTYPE_TO_CODE = {torch.float16: 0, torch.bfloat16: 1, torch.float32: 2} | |
| _CODE_TO_DTYPE = {0: torch.float16, 1: torch.bfloat16, 2: torch.float32} | |
| _CODE_TO_NP_DTYPE = {0: np.float16, 1: np.float16, 2: np.float32} | |
| def tensor_to_embedding_blob(tensor: torch.Tensor) -> bytes: | |
| """Serialize a tensor to compact binary format for SQLite blob storage. | |
| Format: [version:1][dtype_code:1][ndim:4][shape:4*ndim][raw_bytes] | |
| bfloat16 tensors are stored as float16 bytes (numpy lacks bfloat16) | |
| but tagged with dtype_code=1 so they can be cast back on read. | |
| Falls back to torch.save for unsupported dtypes. | |
| """ | |
| t = tensor.cpu() | |
| if t.dtype not in _DTYPE_TO_CODE: | |
| buffer = io.BytesIO() | |
| torch.save(t, buffer) | |
| return buffer.getvalue() | |
| dtype_code = _DTYPE_TO_CODE[t.dtype] | |
| if t.dtype == torch.bfloat16: | |
| raw = t.half().numpy().tobytes() | |
| else: | |
| raw = t.numpy().tobytes() | |
| shape = t.shape | |
| header = struct.pack(f'<BBi{len(shape)}i', _COMPACT_VERSION, dtype_code, len(shape), *shape) | |
| return header + raw | |
| def _compact_header(dtype: torch.dtype, shape: tuple) -> bytes: | |
| """Build just the compact header for a given dtype and shape.""" | |
| dtype_code = _DTYPE_TO_CODE[dtype] | |
| return struct.pack(f'<BBi{len(shape)}i', _COMPACT_VERSION, dtype_code, len(shape), *shape) | |
| def batch_tensor_to_blobs(batch: torch.Tensor) -> List[bytes]: | |
| """Serialize a batch of same-shape tensors to compact blobs (fast path for vectors). | |
| Builds the header once and slices raw bytes per row. Much faster than | |
| per-row tensor_to_embedding_blob calls for uniform-shape batches. | |
| """ | |
| assert batch.ndim >= 2, f"Expected batch with >= 2 dims, got {batch.ndim}" | |
| t = batch.cpu() | |
| store_dtype = t.dtype | |
| if t.dtype not in _DTYPE_TO_CODE: | |
| return [tensor_to_embedding_blob(t[i]) for i in range(t.shape[0])] | |
| if t.dtype == torch.bfloat16: | |
| arr = t.half().numpy() | |
| store_dtype = torch.bfloat16 | |
| else: | |
| arr = t.numpy() | |
| row_shape = tuple(t.shape[1:]) | |
| header = _compact_header(store_dtype, row_shape) | |
| raw = arr.tobytes() | |
| stride = len(raw) // t.shape[0] | |
| return [header + raw[i * stride:(i + 1) * stride] for i in range(t.shape[0])] | |
| def embedding_blob_to_tensor(blob: bytes, fallback_shape: Optional[Tuple[int, ...]] = None) -> torch.Tensor: | |
| """Deserialize a blob back to a tensor. Auto-detects compact vs legacy formats.""" | |
| if len(blob) >= 6 and blob[0] == _COMPACT_VERSION: | |
| dtype_code = blob[1] | |
| ndim = struct.unpack_from('<i', blob, 2)[0] | |
| shape = struct.unpack_from(f'<{ndim}i', blob, 6) | |
| data_offset = 6 + 4 * ndim | |
| np_dtype = _CODE_TO_NP_DTYPE[dtype_code] | |
| arr = np.frombuffer(blob, dtype=np_dtype, offset=data_offset).copy().reshape(shape) | |
| t = torch.from_numpy(arr) | |
| target_dtype = _CODE_TO_DTYPE[dtype_code] | |
| if target_dtype != t.dtype: | |
| t = t.to(target_dtype) | |
| return t | |
| # Older `.pth`-style blobs were written with torch.save. | |
| try: | |
| buffer = io.BytesIO(blob) | |
| return torch.load(buffer, map_location='cpu', weights_only=True) | |
| except Exception: | |
| pass | |
| # Oldest SQLite rows stored raw float32 bytes and need a caller-supplied shape. | |
| assert fallback_shape is not None, "Cannot deserialize blob: unknown format and no fallback_shape provided." | |
| arr = np.frombuffer(blob, dtype=np.float32).copy().reshape(fallback_shape) | |
| return torch.from_numpy(arr) | |
| def select_hidden_state_embeddings( | |
| last_hidden_state: torch.Tensor, | |
| hidden_states: Optional[Tuple[torch.Tensor, ...]], | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| ) -> torch.Tensor: | |
| assert isinstance(hidden_state_index, int), "hidden_state_index must be an integer." | |
| if store_all_hidden_states: | |
| assert hidden_states is not None, "store_all_hidden_states requires output_hidden_states=True." | |
| assert len(hidden_states) > 0, "Model returned no hidden states." | |
| return torch.stack(tuple(hidden_states), dim=1) | |
| if hidden_state_index == -1: | |
| return last_hidden_state | |
| assert hidden_states is not None, "hidden_state_index selection requires output_hidden_states=True." | |
| return hidden_states[hidden_state_index] | |
| def _trim_full_embedding(embedding: torch.Tensor, attention_mask: torch.Tensor) -> torch.Tensor: | |
| mask = attention_mask.bool() | |
| if embedding.ndim == 2: | |
| return embedding[mask].reshape(-1, embedding.shape[-1]) | |
| if embedding.ndim == 3: | |
| return embedding[:, mask, :].reshape(embedding.shape[0], -1, embedding.shape[-1]) | |
| raise AssertionError(f"Expected full embedding tensor with 2 or 3 dims, got {embedding.ndim}.") | |
| def pool_embeddings( | |
| embeddings: Dict[str, torch.Tensor], | |
| pooling_types: List[str] = ['mean'], | |
| hidden_state_index: int = -1, | |
| ) -> Dict[str, torch.Tensor]: | |
| pooler = Pooler(pooling_types) | |
| pooled: Dict[str, torch.Tensor] = {} | |
| for sequence, embedding in embeddings.items(): | |
| assert isinstance(sequence, str), "Expected embedding dictionary keys to be sequences (str)." | |
| assert isinstance(embedding, torch.Tensor), "Expected embedding dictionary values to be tensors." | |
| if embedding.ndim == 1: | |
| pooled[sequence] = embedding.cpu() | |
| continue | |
| if embedding.ndim == 3: | |
| embedding = embedding[hidden_state_index] | |
| assert embedding.ndim == 2, f"Expected token-wise embedding with 2 dims, got {embedding.ndim}." | |
| pooled[sequence] = pooler(embedding.unsqueeze(0)).squeeze(0).cpu() | |
| return pooled | |
| def load_pooled_embeddings_from_pth( | |
| save_path: str, | |
| pooling_types: List[str] = ['mean'], | |
| hidden_state_index: int = -1, | |
| ) -> Dict[str, torch.Tensor]: | |
| assert os.path.exists(save_path), f"Embedding file does not exist: {save_path}" | |
| payload = torch.load(save_path, map_location="cpu", weights_only=True) | |
| assert isinstance(payload, dict), "Expected .pth embeddings file to contain a dictionary." | |
| return pool_embeddings(payload, pooling_types=pooling_types, hidden_state_index=hidden_state_index) | |
| def load_pooled_embeddings_from_db( | |
| db_path: str, | |
| sequences: Optional[List[str]] = None, | |
| pooling_types: List[str] = ['mean'], | |
| hidden_state_index: int = -1, | |
| ) -> Dict[str, torch.Tensor]: | |
| assert os.path.exists(db_path), f"Embedding database does not exist: {db_path}" | |
| loaded: Dict[str, torch.Tensor] = {} | |
| with sqlite3.connect(db_path, timeout=30) as conn: | |
| cursor = conn.cursor() | |
| if sequences is None: | |
| cursor.execute("SELECT sequence, embedding FROM embeddings") | |
| else: | |
| if len(sequences) == 0: | |
| return loaded | |
| placeholders = ",".join(["?"] * len(sequences)) | |
| cursor.execute( | |
| f"SELECT sequence, embedding FROM embeddings WHERE sequence IN ({placeholders})", | |
| tuple(sequences), | |
| ) | |
| for sequence, embedding_bytes in cursor.fetchall(): | |
| loaded[sequence] = embedding_blob_to_tensor(embedding_bytes) | |
| return pool_embeddings(loaded, pooling_types=pooling_types, hidden_state_index=hidden_state_index) | |
| def maybe_compile(model: torch.nn.Module, dynamic: bool = False) -> torch.nn.Module: | |
| """Compile model with torch.compile if possible. | |
| Skips compilation when dynamic=True (padding='longest') because | |
| flex attention's create_block_mask is incompatible with dynamic shapes | |
| under torch.compile, causing CUDA illegal memory access. | |
| """ | |
| if dynamic: | |
| print("Skipping torch.compile (dynamic shapes + flex attention incompatible)") | |
| return model | |
| try: | |
| model = torch.compile(model) | |
| print("Model compiled") | |
| except Exception as e: | |
| print(f"Skipping torch.compile: {e}") | |
| return model | |
| def build_collator( | |
| tokenizer: PreTrainedTokenizerBase, | |
| padding: str = 'max_length', | |
| max_length: int = 512, | |
| ) -> Callable[[List[str]], Dict[str, torch.Tensor]]: | |
| def _collate_fn(sequences: List[str]) -> Dict[str, torch.Tensor]: | |
| kwargs: Dict[str, Any] = dict( | |
| return_tensors="pt", padding=padding, truncation=True, max_length=max_length, | |
| ) | |
| if padding != 'max_length': | |
| kwargs['pad_to_multiple_of'] = 8 | |
| return tokenizer(sequences, **kwargs) | |
| return _collate_fn | |
| def _make_embedding_progress( | |
| dataloader: DataLoader, | |
| padding: str, | |
| n_warmup: int = 3, | |
| n_calibration: int = 5, | |
| ) -> Iterator[Tuple[int, Any]]: | |
| """Progress-bar wrapper for embedding loops. Drop-in replacement for enumerate(dataloader). | |
| When padding='max_length', all batches have uniform cost so plain tqdm works. | |
| When padding='longest' (sorted longest-first), batch times vary dramatically. | |
| In that case: yield warmup batches first (compiler warmup + OOM check on longest | |
| sequences), then time mid-length calibration batches to estimate total ETA. | |
| Keep in sync with protify/embedder.py and core/atlas/precomputed.py. | |
| """ | |
| total = len(dataloader) | |
| if padding == 'max_length' or total <= n_warmup + n_calibration: | |
| for i, batch in tqdm(enumerate(dataloader), total=total, desc='Embedding batches'): | |
| yield i, batch | |
| return | |
| dl_iter = iter(dataloader) | |
| # Warm up on the longest batches first; sorted inputs make these the OOM-risk | |
| # and compile-stabilization cases. | |
| warmup_bar = tqdm(range(n_warmup), desc='Warmup (longest batches)', leave=False) | |
| for i in warmup_bar: | |
| batch = next(dl_iter) | |
| yield i, batch | |
| warmup_bar.close() | |
| # Move toward mid-length batches for ETA calibration, yielding every real | |
| # batch on the way so no sequences are skipped. | |
| mid_start = total // 2 | |
| intermediate_bar = tqdm( | |
| range(n_warmup, mid_start), desc='Embedding batches', leave=False, | |
| ) | |
| for i in intermediate_bar: | |
| batch = next(dl_iter) | |
| yield i, batch | |
| intermediate_bar.close() | |
| # Mid-length batches give a better remaining-time estimate than the longest | |
| # warmup batches. | |
| calibration_times: List[float] = [] | |
| cal_bar = tqdm(range(n_calibration), desc='Calibrating ETA', leave=False) | |
| for j in cal_bar: | |
| t0 = time.perf_counter() | |
| batch = next(dl_iter) | |
| yield mid_start + j, batch | |
| calibration_times.append(time.perf_counter() - t0) | |
| cal_bar.close() | |
| avg_time = sum(calibration_times) / len(calibration_times) | |
| remaining_start = mid_start + n_calibration | |
| remaining_count = total - remaining_start | |
| estimated_total_seconds = avg_time * remaining_count | |
| # Finish the tail with the calibrated ETA shown in the progress bar. | |
| main_bar = tqdm( | |
| range(remaining_count), | |
| desc='Embedding batches', | |
| bar_format='{l_bar}{bar}| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, {rate_fmt}]', | |
| ) | |
| main_bar.set_postfix_str(f'ETA ~{estimated_total_seconds:.0f}s (calibrated)') | |
| for k in main_bar: | |
| batch = next(dl_iter) | |
| yield remaining_start + k, batch | |
| main_bar.close() | |
| class _SQLWriter: | |
| """Context manager for async SQL embedding writes. Matches core/embed/storage.SQLEmbeddingWriter.""" | |
| def __init__(self, conn: sqlite3.Connection, queue_maxsize: int = 4) -> None: | |
| self._conn = conn | |
| self._queue: queue.Queue = queue.Queue(maxsize=queue_maxsize) | |
| self._thread: Optional[threading.Thread] = None | |
| def __enter__(self) -> "_SQLWriter": | |
| self._thread = threading.Thread(target=self._writer_loop, daemon=True) | |
| self._thread.start() | |
| return self | |
| def write_batch(self, rows: List[Tuple[str, bytes]]) -> None: | |
| self._queue.put(rows) | |
| def _writer_loop(self) -> None: | |
| cursor = self._conn.cursor() | |
| while True: | |
| item = self._queue.get() | |
| if item is None: | |
| break | |
| cursor.executemany("INSERT OR REPLACE INTO embeddings VALUES (?, ?)", item) | |
| if self._queue.qsize() == 0: | |
| self._conn.commit() | |
| self._conn.commit() | |
| def __exit__(self, *exc) -> None: | |
| if self._thread is not None: | |
| self._queue.put(None) | |
| self._thread.join() | |
| self._thread = None | |
| class Pooler: | |
| def __init__(self, pooling_types: List[str]) -> None: | |
| self.pooling_types = pooling_types | |
| self.pooling_options: Dict[str, Callable] = { | |
| 'mean': self.mean_pooling, | |
| 'max': self.max_pooling, | |
| 'norm': self.norm_pooling, | |
| 'median': self.median_pooling, | |
| 'std': self.std_pooling, | |
| 'var': self.var_pooling, | |
| 'cls': self.cls_pooling, | |
| 'parti': self._pool_parti, | |
| } | |
| def _create_pooled_matrices_across_layers(self, attentions: torch.Tensor) -> torch.Tensor: | |
| assert isinstance(attentions, torch.Tensor) | |
| maxed_attentions = torch.max(attentions, dim=1)[0] | |
| return maxed_attentions | |
| def _page_rank(self, attention_matrix: np.ndarray, personalization: Optional[dict] = None, nstart: Optional[dict] = None, prune_type: str = "top_k_outdegree") -> Dict[int, float]: | |
| G = self._convert_to_graph(attention_matrix) | |
| if G.number_of_nodes() != attention_matrix.shape[0]: | |
| raise Exception( | |
| f"The number of nodes in the graph should be equal to the number of tokens in sequence! You have {G.number_of_nodes()} nodes for {attention_matrix.shape[0]} tokens.") | |
| if G.number_of_edges() == 0: | |
| raise Exception(f"You don't seem to have any attention edges left in the graph.") | |
| return nx.pagerank(G, alpha=0.85, tol=1e-06, weight='weight', personalization=personalization, nstart=nstart, max_iter=100) | |
| def _convert_to_graph(self, matrix: np.ndarray) -> nx.DiGraph: | |
| G = nx.from_numpy_array(matrix, create_using=nx.DiGraph) | |
| return G | |
| def _calculate_importance_weights(self, dict_importance: Dict[int, float], attention_mask: Optional[torch.Tensor] = None) -> np.ndarray: | |
| if attention_mask is not None: | |
| for k in list(dict_importance.keys()): | |
| if attention_mask[k] == 0: | |
| del dict_importance[k] | |
| total = sum(dict_importance.values()) | |
| return np.array([v / total for _, v in dict_importance.items()]) | |
| def _pool_parti(self, emb: torch.Tensor, attentions: torch.Tensor, attention_mask: Optional[torch.Tensor] = None) -> torch.Tensor: | |
| maxed_attentions = self._create_pooled_matrices_across_layers(attentions).numpy() | |
| emb_pooled = [] | |
| for e, a, mask in zip(emb, maxed_attentions, attention_mask): | |
| dict_importance = self._page_rank(a) | |
| importance_weights = self._calculate_importance_weights(dict_importance, mask) | |
| num_tokens = int(mask.sum().item()) | |
| emb_pooled.append(np.average(e[:num_tokens], weights=importance_weights, axis=0)) | |
| pooled = torch.tensor(np.array(emb_pooled)) | |
| return pooled | |
| def mean_pooling(self, emb: torch.Tensor, attention_mask: Optional[torch.Tensor] = None, **kwargs) -> torch.Tensor: | |
| if attention_mask is None: | |
| return emb.mean(dim=1) | |
| else: | |
| attention_mask = attention_mask.unsqueeze(-1) | |
| return (emb * attention_mask).sum(dim=1) / attention_mask.sum(dim=1) | |
| def max_pooling(self, emb: torch.Tensor, attention_mask: Optional[torch.Tensor] = None, **kwargs) -> torch.Tensor: | |
| if attention_mask is None: | |
| return emb.max(dim=1).values | |
| else: | |
| mask = attention_mask.unsqueeze(-1).bool() | |
| return emb.masked_fill(~mask, float('-inf')).max(dim=1).values | |
| def norm_pooling(self, emb: torch.Tensor, attention_mask: Optional[torch.Tensor] = None, **kwargs) -> torch.Tensor: | |
| if attention_mask is None: | |
| return emb.norm(dim=1, p=2) | |
| else: | |
| attention_mask = attention_mask.unsqueeze(-1) | |
| return (emb * attention_mask).norm(dim=1, p=2) | |
| def median_pooling(self, emb: torch.Tensor, attention_mask: Optional[torch.Tensor] = None, **kwargs) -> torch.Tensor: | |
| if attention_mask is None: | |
| return emb.median(dim=1).values | |
| else: | |
| mask = attention_mask.unsqueeze(-1).bool() | |
| return emb.masked_fill(~mask, float('nan')).nanmedian(dim=1).values | |
| def std_pooling(self, emb: torch.Tensor, attention_mask: Optional[torch.Tensor] = None, **kwargs) -> torch.Tensor: | |
| if attention_mask is None: | |
| return emb.std(dim=1) | |
| else: | |
| var = self.var_pooling(emb, attention_mask, **kwargs) | |
| return torch.sqrt(var) | |
| def var_pooling(self, emb: torch.Tensor, attention_mask: Optional[torch.Tensor] = None, **kwargs) -> torch.Tensor: | |
| if attention_mask is None: | |
| return emb.var(dim=1) | |
| else: | |
| attention_mask = attention_mask.unsqueeze(-1) | |
| mean = (emb * attention_mask).sum(dim=1) / attention_mask.sum(dim=1) | |
| mean = mean.unsqueeze(1) | |
| squared_diff = (emb - mean) ** 2 | |
| var = (squared_diff * attention_mask).sum(dim=1) / attention_mask.sum(dim=1) | |
| return var | |
| def cls_pooling(self, emb: torch.Tensor, attention_mask: Optional[torch.Tensor] = None, **kwargs) -> torch.Tensor: | |
| return emb[:, 0, :] | |
| def __call__( | |
| self, | |
| emb: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| attentions: Optional[torch.Tensor] = None | |
| ) -> torch.Tensor: | |
| if attention_mask is not None: | |
| assert attention_mask.sum(dim=-1).min() > 0, ( | |
| "Pooler received samples with all-zero attention masks. " | |
| "This causes NaN from division by zero. Filter empty inputs before pooling." | |
| ) | |
| final_emb: List[torch.Tensor] = [] | |
| for pooling_type in self.pooling_types: | |
| final_emb.append(self.pooling_options[pooling_type](emb=emb, attention_mask=attention_mask, attentions=attentions)) | |
| return torch.cat(final_emb, dim=-1) | |
| class ProteinDataset(TorchDataset): | |
| """Simple dataset for protein sequences.""" | |
| def __init__(self, sequences: List[str]) -> None: | |
| self.sequences = sequences | |
| def __len__(self) -> int: | |
| return len(self.sequences) | |
| def __getitem__(self, idx: int) -> str: | |
| return self.sequences[idx] | |
| def parse_fasta(fasta_path: str) -> List[str]: | |
| assert os.path.exists(fasta_path), f"FASTA file does not exist: {fasta_path}" | |
| sequences = [] | |
| current_seq = [] | |
| with open(fasta_path, 'r') as f: | |
| for line in f: | |
| line = line.strip() | |
| if not line: | |
| continue | |
| if line.startswith('>'): | |
| if current_seq: | |
| sequences.append(''.join(current_seq)) | |
| current_seq = [] | |
| else: | |
| current_seq.append(line) | |
| if current_seq: | |
| sequences.append(''.join(current_seq)) | |
| return sequences | |
| class EmbeddingMixin: | |
| def _embed( | |
| self, | |
| input_ids: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| ) -> torch.Tensor: | |
| raise NotImplementedError | |
| def device(self) -> torch.device: | |
| """Get the device of the model.""" | |
| return next(self.parameters()).device | |
| def _read_sequences_from_db(self, db_path: str) -> Set[str]: | |
| """Read sequences from SQLite database.""" | |
| with sqlite3.connect(db_path, timeout=30) as conn: | |
| c = conn.cursor() | |
| c.execute("SELECT sequence FROM embeddings") | |
| return {row[0] for row in c.fetchall()} | |
| def _ensure_embeddings_table(self, conn: sqlite3.Connection) -> None: | |
| cursor = conn.cursor() | |
| cursor.execute( | |
| "CREATE TABLE IF NOT EXISTS embeddings (" | |
| "sequence TEXT PRIMARY KEY, " | |
| "embedding BLOB NOT NULL" | |
| ")" | |
| ) | |
| conn.commit() | |
| def load_embeddings_from_pth(self, save_path: str) -> Dict[str, torch.Tensor]: | |
| assert os.path.exists(save_path), f"Embedding file does not exist: {save_path}" | |
| payload = torch.load(save_path, map_location="cpu", weights_only=True) | |
| assert isinstance(payload, dict), "Expected .pth embeddings file to contain a dictionary." | |
| for sequence, tensor in payload.items(): | |
| assert isinstance(sequence, str), "Expected embedding dictionary keys to be sequences (str)." | |
| assert isinstance(tensor, torch.Tensor), "Expected embedding dictionary values to be tensors." | |
| return payload | |
| def load_embeddings_from_db(self, db_path: str, sequences: Optional[List[str]] = None) -> Dict[str, torch.Tensor]: | |
| assert os.path.exists(db_path), f"Embedding database does not exist: {db_path}" | |
| loaded: Dict[str, torch.Tensor] = {} | |
| with sqlite3.connect(db_path, timeout=30) as conn: | |
| self._ensure_embeddings_table(conn) | |
| cursor = conn.cursor() | |
| if sequences is None: | |
| cursor.execute("SELECT sequence, embedding FROM embeddings") | |
| else: | |
| if len(sequences) == 0: | |
| return loaded | |
| placeholders = ",".join(["?"] * len(sequences)) | |
| cursor.execute( | |
| f"SELECT sequence, embedding FROM embeddings WHERE sequence IN ({placeholders})", | |
| tuple(sequences), | |
| ) | |
| rows = cursor.fetchall() | |
| for row in rows: | |
| sequence = row[0] | |
| embedding_bytes = row[1] | |
| loaded[sequence] = embedding_blob_to_tensor(embedding_bytes) | |
| return loaded | |
| def pool_embeddings( | |
| self, | |
| embeddings: Dict[str, torch.Tensor], | |
| pooling_types: List[str] = ['mean'], | |
| hidden_state_index: int = -1, | |
| ) -> Dict[str, torch.Tensor]: | |
| return pool_embeddings(embeddings, pooling_types=pooling_types, hidden_state_index=hidden_state_index) | |
| def load_pooled_embeddings_from_pth( | |
| self, | |
| save_path: str, | |
| pooling_types: List[str] = ['mean'], | |
| hidden_state_index: int = -1, | |
| ) -> Dict[str, torch.Tensor]: | |
| return load_pooled_embeddings_from_pth( | |
| save_path, | |
| pooling_types=pooling_types, | |
| hidden_state_index=hidden_state_index, | |
| ) | |
| def load_pooled_embeddings_from_db( | |
| self, | |
| db_path: str, | |
| sequences: Optional[List[str]] = None, | |
| pooling_types: List[str] = ['mean'], | |
| hidden_state_index: int = -1, | |
| ) -> Dict[str, torch.Tensor]: | |
| return load_pooled_embeddings_from_db( | |
| db_path, | |
| sequences=sequences, | |
| pooling_types=pooling_types, | |
| hidden_state_index=hidden_state_index, | |
| ) | |
| def embed_dataset( | |
| self, | |
| sequences: Optional[List[str]] = None, | |
| tokenizer: Optional[PreTrainedTokenizerBase] = None, | |
| batch_size: int = 2, | |
| max_len: int = 512, | |
| truncate: bool = True, | |
| full_embeddings: bool = False, | |
| embed_dtype: torch.dtype = torch.float32, | |
| pooling_types: List[str] = ['mean'], | |
| num_workers: int = 0, | |
| sql: bool = False, | |
| save: bool = True, | |
| sql_db_path: str = 'embeddings.db', | |
| save_path: str = 'embeddings.pth', | |
| fasta_path: Optional[str] = None, | |
| padding: str = 'max_length', | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| **kwargs, | |
| ) -> Optional[Dict[str, torch.Tensor]]: | |
| """ | |
| Embed a dataset of protein sequences. | |
| Supports two modes: | |
| - Tokenizer mode (ESM2/ESM++): provide `tokenizer` or use `self.tokenizer`. | |
| - Sequence mode (E1): pass `tokenizer=None`, `_embed(sequences, return_attention_mask=True, **kwargs)` is used. | |
| Sequences can be supplied as a list via `sequences`, parsed from a FASTA file via | |
| `fasta_path`, or both (the two sources are combined). At least one must be provided. | |
| """ | |
| if fasta_path is not None: | |
| fasta_sequences = parse_fasta(fasta_path) | |
| sequences = list(sequences or []) + fasta_sequences | |
| assert sequences is not None and len(sequences) > 0, \ | |
| "Must provide at least one sequence via `sequences` or `fasta_path`." | |
| assert isinstance(hidden_state_index, int), "hidden_state_index must be an integer." | |
| assert full_embeddings or not store_all_hidden_states, \ | |
| "store_all_hidden_states=True requires full_embeddings=True." | |
| sequences = list(set([seq[:max_len] if truncate else seq for seq in sequences])) | |
| sequences = sorted(sequences, key=len, reverse=True) | |
| pooler = Pooler(pooling_types) if not full_embeddings else None | |
| if tokenizer is None and self.config.model_type != "E1": | |
| tokenizer = self.tokenizer | |
| tokenizer_mode = tokenizer is not None | |
| # Resolve padding and compilation | |
| dynamic = padding == 'longest' | |
| compiled_model = maybe_compile(self, dynamic=dynamic) | |
| if tokenizer_mode: | |
| collate_fn = build_collator(tokenizer, padding=padding, max_length=max_len) | |
| device = self.device | |
| else: | |
| collate_fn = None | |
| device = None | |
| def get_embeddings(residue_embeddings: torch.Tensor, attention_mask: Optional[torch.Tensor] = None) -> torch.Tensor: | |
| assert isinstance(residue_embeddings, torch.Tensor) | |
| if full_embeddings or residue_embeddings.ndim == 2: | |
| return residue_embeddings | |
| return pooler(residue_embeddings, attention_mask) | |
| def iter_batches(to_embed: List[str]): | |
| if tokenizer_mode: | |
| assert collate_fn is not None | |
| assert device is not None | |
| dataset = ProteinDataset(to_embed) | |
| dataloader = DataLoader( | |
| dataset, | |
| batch_size=batch_size, | |
| num_workers=num_workers, | |
| prefetch_factor=2 if num_workers > 0 else None, | |
| collate_fn=collate_fn, | |
| shuffle=False, | |
| pin_memory=True, | |
| ) | |
| for i, batch in _make_embedding_progress(dataloader, padding): | |
| seqs = to_embed[i * batch_size:(i + 1) * batch_size] | |
| input_ids = batch['input_ids'].to(device) | |
| attention_mask = batch['attention_mask'].to(device) | |
| residue_embeddings = compiled_model._embed( | |
| input_ids, | |
| attention_mask, | |
| hidden_state_index=hidden_state_index, | |
| store_all_hidden_states=store_all_hidden_states, | |
| ) | |
| yield seqs, residue_embeddings, attention_mask | |
| else: | |
| for batch_start in tqdm(range(0, len(to_embed), batch_size), desc='Embedding batches'): | |
| seqs = to_embed[batch_start:batch_start + batch_size] | |
| batch_output = compiled_model._embed( | |
| seqs, | |
| return_attention_mask=True, | |
| hidden_state_index=hidden_state_index, | |
| store_all_hidden_states=store_all_hidden_states, | |
| **kwargs, | |
| ) | |
| assert isinstance(batch_output, tuple), "Sequence mode _embed must return (last_hidden_state, attention_mask)." | |
| assert len(batch_output) == 2, "Sequence mode _embed must return exactly two values." | |
| residue_embeddings, attention_mask = batch_output | |
| assert isinstance(attention_mask, torch.Tensor), "Sequence mode _embed must return attention_mask as a torch.Tensor." | |
| yield seqs, residue_embeddings, attention_mask | |
| if sql: | |
| # Resume safely: skip sequences already present in the SQLite table. | |
| conn = sqlite3.connect(sql_db_path, timeout=30, check_same_thread=False) | |
| conn.execute('PRAGMA journal_mode=WAL') | |
| conn.execute('PRAGMA busy_timeout=30000') | |
| conn.execute('PRAGMA synchronous=OFF') | |
| conn.execute('PRAGMA cache_size=-64000') | |
| self._ensure_embeddings_table(conn) | |
| already_embedded = self._read_sequences_from_db(sql_db_path) | |
| to_embed = [seq for seq in sequences if seq not in already_embedded] | |
| print(f"Found {len(already_embedded)} already embedded sequences in {sql_db_path}") | |
| print(f"Embedding {len(to_embed)} new sequences") | |
| if len(to_embed) > 0: | |
| # Embed batches synchronously; serialize/write them on the SQL writer thread. | |
| with _SQLWriter(conn) as writer: | |
| with torch.inference_mode(): | |
| for seqs, residue_embeddings, attention_mask in iter_batches(to_embed): | |
| embeddings = get_embeddings(residue_embeddings, attention_mask).to(embed_dtype) | |
| if full_embeddings: | |
| batch_rows = [] | |
| for seq, emb, mask in zip(seqs, embeddings, attention_mask): | |
| batch_rows.append((seq, tensor_to_embedding_blob(_trim_full_embedding(emb, mask)))) | |
| else: | |
| blobs = batch_tensor_to_blobs(embeddings) | |
| batch_rows = list(zip(seqs, blobs)) | |
| writer.write_batch(batch_rows) | |
| conn.close() | |
| return None | |
| embeddings_dict = {} | |
| if os.path.exists(save_path): | |
| embeddings_dict = self.load_embeddings_from_pth(save_path) | |
| to_embed = [seq for seq in sequences if seq not in embeddings_dict] | |
| print(f"Found {len(embeddings_dict)} already embedded sequences in {save_path}") | |
| print(f"Embedding {len(to_embed)} new sequences") | |
| else: | |
| to_embed = sequences | |
| print(f"Embedding {len(to_embed)} new sequences") | |
| if len(to_embed) > 0: | |
| with torch.inference_mode(): | |
| for seqs, residue_embeddings, attention_mask in iter_batches(to_embed): | |
| embeddings = get_embeddings(residue_embeddings, attention_mask).to(embed_dtype) | |
| for seq, emb, mask in zip(seqs, embeddings, attention_mask): | |
| if full_embeddings: | |
| emb = _trim_full_embedding(emb, mask) | |
| embeddings_dict[seq] = emb.cpu() | |
| if save: | |
| torch.save(embeddings_dict, save_path) | |
| return embeddings_dict | |
| if __name__ == "__main__": | |
| # Manual smoke test for pooling shape behavior. | |
| pooler = Pooler(pooling_types=['max', 'parti']) | |
| batch_size = 8 | |
| seq_len = 64 | |
| hidden_size = 128 | |
| num_layers = 12 | |
| emb = torch.randn(batch_size, seq_len, hidden_size) | |
| attentions = torch.randn(batch_size, num_layers, seq_len, seq_len) | |
| attention_mask = torch.ones(batch_size, seq_len) | |
| y = pooler(emb=emb, attention_mask=attention_mask, attentions=attentions) | |
| print(y.shape) | |
| """Shared attention infrastructure for all FastPLMs models. | |
| Contains: AttentionBackend enum, backend resolution, mask creation, | |
| flex attention helpers, flash kernel detection/dispatch, and pad/unpad utilities. | |
| """ | |
| from enum import Enum | |
| from typing import Dict, List, Optional, Tuple | |
| import torch | |
| import torch.nn as nn | |
| from torch.nn import functional as F | |
| from einops import rearrange | |
| try: | |
| from torch.nn.attention.flex_attention import create_block_mask, flex_attention, BlockMask | |
| except ImportError: | |
| create_block_mask = None | |
| flex_attention = None | |
| BlockMask = None | |
| _compiled_flex_attention = None | |
| def _get_flex_attention_fn(): | |
| """Return flex_attention callable: compiled (fused kernel) by default, or eager when debug flag is set.""" | |
| global _compiled_flex_attention | |
| if flex_attention is None: | |
| return None | |
| flex_mod = torch.nn.attention.flex_attention | |
| if getattr(flex_mod, "_FLEX_ATTENTION_DISABLE_COMPILE_DEBUG", False): | |
| return flex_attention | |
| if _compiled_flex_attention is None: | |
| _compiled_flex_attention = torch.compile( | |
| flex_attention, | |
| dynamic=False, | |
| ) | |
| return _compiled_flex_attention | |
| # HuggingFace `kernels` exposes slightly different APIs for Flash Attention 2 | |
| # and 3. Detect the loaded variant once so every caller uses the same dispatch. | |
| def _infer_kernels_flash_variant(kernel) -> Optional[str]: | |
| if hasattr(kernel, "fwd") and hasattr(kernel, "varlen_fwd"): | |
| return "flash_attn2" | |
| if hasattr(kernel, "flash_attn_func") and hasattr(kernel, "flash_attn_varlen_func"): | |
| return "flash_attn3" | |
| return None | |
| def _try_get_kernels_flash(): | |
| try: | |
| from kernels import get_kernel | |
| except ImportError: | |
| return None, None | |
| flash_kernel = None | |
| flash_kernel_variant = None | |
| try: | |
| flash_kernel = get_kernel("kernels-community/flash-attn3") | |
| flash_kernel_variant = _infer_kernels_flash_variant(flash_kernel) | |
| assert flash_kernel_variant is not None, "Loaded flash-attn3 kernel does not expose a supported API." | |
| except Exception: | |
| try: | |
| flash_kernel = get_kernel("kernels-community/flash-attn2") | |
| flash_kernel_variant = _infer_kernels_flash_variant(flash_kernel) | |
| assert flash_kernel_variant is not None, "Loaded flash-attn2 kernel does not expose a supported API." | |
| except Exception: | |
| flash_kernel = None | |
| flash_kernel_variant = None | |
| return flash_kernel, flash_kernel_variant | |
| _FLASH_KERNELS_LOADED = False | |
| FLASH_KERNEL = None | |
| FLASH_KERNEL_VARIANT = None | |
| def _ensure_flash_kernels_loaded(): | |
| global _FLASH_KERNELS_LOADED, FLASH_KERNEL, FLASH_KERNEL_VARIANT | |
| if _FLASH_KERNELS_LOADED: | |
| return | |
| _FLASH_KERNELS_LOADED = True | |
| FLASH_KERNEL, FLASH_KERNEL_VARIANT = _try_get_kernels_flash() | |
| def _kernels_flash_forward( | |
| query_states: torch.Tensor, | |
| key_states: torch.Tensor, | |
| value_states: torch.Tensor, | |
| causal: bool = False, | |
| softmax_scale: Optional[float] = None, | |
| ) -> torch.Tensor: | |
| """Flash-attention forward, optionally overriding the softmax scale. | |
| When `softmax_scale is None`, the flash kernel applies its default | |
| `1 / sqrt(head_dim)`. Pass `softmax_scale=1.0` if the caller has already | |
| pre-scaled Q (the convention used by ESM2, DPLM, DPLM2, E1, ESMFold). | |
| Failing to override when Q is pre-scaled applies the scale twice. On | |
| DPLM-150M, that produced pooled-embedding cosine around -0.12 and argmax | |
| agreement around 0.27 vs SDPA. | |
| """ | |
| assert FLASH_KERNEL is not None, "Kernel Flash Attention is not available in this environment." | |
| if FLASH_KERNEL_VARIANT == "flash_attn2": | |
| return FLASH_KERNEL.fwd( | |
| q=query_states, k=key_states, v=value_states, | |
| softmax_scale=softmax_scale, is_causal=causal, | |
| )[0] | |
| if FLASH_KERNEL_VARIANT == "flash_attn3": | |
| try: | |
| output = FLASH_KERNEL.flash_attn_func( | |
| q=query_states, k=key_states, v=value_states, | |
| softmax_scale=softmax_scale, causal=causal, | |
| ) | |
| except TypeError: | |
| output = FLASH_KERNEL.flash_attn_func( | |
| query_states, key_states, value_states, | |
| 0.0, softmax_scale, causal, | |
| ) | |
| if isinstance(output, tuple): | |
| return output[0] | |
| return output | |
| raise AssertionError(f"Unsupported kernels flash attention variant: {FLASH_KERNEL_VARIANT}") | |
| def _kernels_flash_varlen_forward( | |
| query_states: torch.Tensor, | |
| key_states: torch.Tensor, | |
| value_states: torch.Tensor, | |
| cu_seqlens_q: torch.Tensor, | |
| cu_seqlens_k: torch.Tensor, | |
| max_seqlen_in_batch_q: int, | |
| max_seqlen_in_batch_k: int, | |
| causal: bool = False, | |
| softmax_scale: Optional[float] = None, | |
| ) -> torch.Tensor: | |
| """Varlen flash-attention forward, optionally overriding the softmax scale. | |
| See `_kernels_flash_forward` docstring for why `softmax_scale=1.0` must be | |
| passed when Q has been pre-scaled by the caller. | |
| """ | |
| assert FLASH_KERNEL is not None, "Kernel Flash Attention is not available in this environment." | |
| if FLASH_KERNEL_VARIANT == "flash_attn2": | |
| return FLASH_KERNEL.varlen_fwd( | |
| q=query_states, k=key_states, v=value_states, | |
| cu_seqlens_q=cu_seqlens_q, cu_seqlens_k=cu_seqlens_k, | |
| max_seqlen_q=max_seqlen_in_batch_q, max_seqlen_k=max_seqlen_in_batch_k, | |
| softmax_scale=softmax_scale, is_causal=causal, | |
| )[0] | |
| if FLASH_KERNEL_VARIANT == "flash_attn3": | |
| try: | |
| output = FLASH_KERNEL.flash_attn_varlen_func( | |
| q=query_states, k=key_states, v=value_states, | |
| cu_seqlens_q=cu_seqlens_q, cu_seqlens_k=cu_seqlens_k, | |
| max_seqlen_q=max_seqlen_in_batch_q, max_seqlen_k=max_seqlen_in_batch_k, | |
| softmax_scale=softmax_scale, causal=causal, | |
| ) | |
| except TypeError: | |
| output = FLASH_KERNEL.flash_attn_varlen_func( | |
| query_states, key_states, value_states, | |
| cu_seqlens_q, cu_seqlens_k, | |
| max_seqlen_in_batch_q, max_seqlen_in_batch_k, | |
| 0.0, softmax_scale, causal, | |
| ) | |
| if isinstance(output, tuple): | |
| return output[0] | |
| return output | |
| raise AssertionError(f"Unsupported kernels flash attention variant: {FLASH_KERNEL_VARIANT}") | |
| # Varlen flash attention runs only on real tokens. These helpers remove padding | |
| # before the kernel call and restore the original padded batch shape afterward. | |
| class IndexFirstAxis(torch.autograd.Function): | |
| def forward(ctx, input, indices) -> torch.Tensor: | |
| ctx.save_for_backward(indices) | |
| assert input.ndim >= 2 | |
| ctx.first_axis_dim, other_shape = input.shape[0], input.shape[1:] | |
| second_dim = other_shape.numel() | |
| return torch.gather( | |
| rearrange(input, "b ... -> b (...)"), 0, indices.unsqueeze(1).expand(-1, second_dim) | |
| ).reshape(-1, *other_shape) | |
| def backward(ctx, grad_output) -> Tuple[torch.Tensor, None]: | |
| (indices,) = ctx.saved_tensors | |
| assert grad_output.ndim >= 2 | |
| other_shape = grad_output.shape[1:] | |
| grad_output = rearrange(grad_output, "b ... -> b (...)") | |
| grad_input = torch.zeros( | |
| [ctx.first_axis_dim, grad_output.shape[1]], device=grad_output.device, dtype=grad_output.dtype | |
| ) | |
| grad_input.scatter_(0, indices.unsqueeze(1).expand(-1, grad_output.shape[1]), grad_output) | |
| return grad_input.reshape(ctx.first_axis_dim, *other_shape), None | |
| class IndexPutFirstAxis(torch.autograd.Function): | |
| def forward(ctx, values, indices, first_axis_dim) -> torch.Tensor: | |
| ctx.save_for_backward(indices) | |
| assert indices.ndim == 1 | |
| assert values.ndim >= 2 | |
| output = torch.zeros(first_axis_dim, *values.shape[1:], device=values.device, dtype=values.dtype) | |
| output[indices] = values | |
| return output | |
| def backward(ctx, grad_output) -> Tuple[torch.Tensor, None, None]: | |
| (indices,) = ctx.saved_tensors | |
| return grad_output[indices], None, None | |
| index_first_axis = IndexFirstAxis.apply | |
| index_put_first_axis = IndexPutFirstAxis.apply | |
| def pad_input(hidden_states: torch.Tensor, indices: torch.Tensor, batch: int, seqlen: int) -> torch.Tensor: | |
| output = index_put_first_axis(hidden_states, indices, batch * seqlen) | |
| return rearrange(output, "(b s) ... -> b s ...", b=batch) | |
| def _unpad_input( | |
| query_layer: torch.Tensor, | |
| key_layer: torch.Tensor, | |
| value_layer: torch.Tensor, | |
| attention_mask_2d: torch.Tensor, | |
| ) -> Tuple[torch.Tensor, torch.Tensor, torch.Tensor, torch.Tensor, Tuple[torch.Tensor, torch.Tensor], Tuple[int, int]]: | |
| batch_size, seq_len, num_heads, head_dim = query_layer.shape | |
| seqlens = attention_mask_2d.sum(dim=1).int() | |
| cu_seqlens = F.pad(seqlens.cumsum(0, dtype=torch.int32), (1, 0)) | |
| max_seqlen = int(seqlens.max().item()) | |
| indices = attention_mask_2d.flatten().nonzero(as_tuple=False).flatten() | |
| query_layer = index_first_axis(query_layer.reshape(batch_size * seq_len, num_heads, head_dim), indices) | |
| key_layer = index_first_axis(key_layer.reshape(batch_size * seq_len, num_heads, head_dim), indices) | |
| value_layer = index_first_axis(value_layer.reshape(batch_size * seq_len, num_heads, head_dim), indices) | |
| return query_layer, key_layer, value_layer, indices, (cu_seqlens, cu_seqlens), (max_seqlen, max_seqlen) | |
| def kernels_flash_attention_func( | |
| query_states: torch.Tensor, | |
| key_states: torch.Tensor, | |
| value_states: torch.Tensor, | |
| attention_mask_2d: Optional[torch.Tensor] = None, | |
| causal: bool = False, | |
| softmax_scale: Optional[float] = None, | |
| ) -> torch.Tensor: | |
| """Public flash-attention entry point with optional padding handling. | |
| `softmax_scale`: | |
| None -> kernel applies its default `1 / sqrt(head_dim)`. | |
| float -> kernel uses the given scale (pass 1.0 when Q is pre-scaled | |
| by the caller). | |
| Caller contract: if a model family pre-scales Q by `1/sqrt(head_dim)` | |
| before calling this function (ESM2, DPLM, DPLM2, E1, and ESMFold do), pass | |
| `softmax_scale=1.0`. Otherwise the flash kernel applies its default scale | |
| again, yielding an effective `1/head_dim` scale that drifts across layers. | |
| """ | |
| assert FLASH_KERNEL is not None, "Kernel Flash Attention is not available in this environment." | |
| if not causal and attention_mask_2d is not None: | |
| batch_size, q_len = query_states.shape[:2] | |
| ( | |
| query_states, key_states, value_states, | |
| indices_q, (cu_seqlens_q, cu_seqlens_k), (max_seqlen_q, max_seqlen_k), | |
| ) = _unpad_input(query_states, key_states, value_states, attention_mask_2d) | |
| attn_output_unpad = _kernels_flash_varlen_forward( | |
| query_states=query_states, key_states=key_states, value_states=value_states, | |
| cu_seqlens_q=cu_seqlens_q, cu_seqlens_k=cu_seqlens_k, | |
| max_seqlen_in_batch_q=max_seqlen_q, max_seqlen_in_batch_k=max_seqlen_k, | |
| softmax_scale=softmax_scale, | |
| ) | |
| return pad_input(attn_output_unpad, indices_q, batch_size, q_len) | |
| else: | |
| return _kernels_flash_forward( | |
| query_states=query_states, key_states=key_states, value_states=value_states, | |
| causal=causal, softmax_scale=softmax_scale, | |
| ) | |
| # User-facing backend strings resolve to this enum before attention dispatch. | |
| class AttentionBackend(Enum): | |
| AUTO = "auto" | |
| KERNELS_FLASH = "kernels_flash" | |
| FLEX = "flex" | |
| SDPA = "sdpa" | |
| VALID_ATTENTION_BACKENDS = tuple(b.value for b in AttentionBackend) | |
| _BACKEND_CONFIRMED = False | |
| def resolve_attention_backend(requested_backend: str) -> AttentionBackend: | |
| global _BACKEND_CONFIRMED | |
| assert requested_backend in VALID_ATTENTION_BACKENDS, ( | |
| f"Unsupported attention backend: {requested_backend}. Expected one of {VALID_ATTENTION_BACKENDS}." | |
| ) | |
| if requested_backend in (AttentionBackend.AUTO.value, AttentionBackend.KERNELS_FLASH.value): | |
| _ensure_flash_kernels_loaded() | |
| if requested_backend == AttentionBackend.AUTO.value: | |
| if FLASH_KERNEL is not None: | |
| resolved = AttentionBackend.KERNELS_FLASH | |
| elif flex_attention is not None: | |
| resolved = AttentionBackend.FLEX | |
| else: | |
| resolved = AttentionBackend.SDPA | |
| elif requested_backend == AttentionBackend.KERNELS_FLASH.value: | |
| assert FLASH_KERNEL is not None, "Kernels Flash Attention is not available in this environment." | |
| resolved = AttentionBackend.KERNELS_FLASH | |
| elif requested_backend == AttentionBackend.FLEX.value: | |
| assert flex_attention is not None, "Flex Attention is not available in this environment." | |
| resolved = AttentionBackend.FLEX | |
| elif requested_backend == AttentionBackend.SDPA.value: | |
| resolved = AttentionBackend.SDPA | |
| else: | |
| raise AssertionError(f"Unsupported attention backend: {requested_backend}") | |
| if not _BACKEND_CONFIRMED: | |
| print(f"Attention backend: config='{requested_backend}' -> resolved='{resolved.value}'") | |
| _BACKEND_CONFIRMED = True | |
| return resolved | |
| def get_attention_mask( | |
| effective_backend: AttentionBackend, | |
| batch_size: int, | |
| seq_len: int, | |
| device: torch.device, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| ) -> Tuple[Optional[torch.Tensor], Optional[torch.Tensor], Optional[BlockMask]]: | |
| """Build padding masks once for all encoder layers. | |
| Returns (attention_mask_2d, attention_mask_4d, flex_block_mask). | |
| """ | |
| if attention_mask is None: | |
| return None, None, None | |
| attention_mask_2d = attention_mask.bool() | |
| if effective_backend == AttentionBackend.KERNELS_FLASH: | |
| return attention_mask_2d, None, None | |
| if effective_backend == AttentionBackend.FLEX: | |
| assert create_block_mask is not None, "Flex attention backend requested but torch.create_block_mask is unavailable." | |
| valid_lens = attention_mask_2d.sum(dim=-1) | |
| def mask_mod(batch_idx, head_idx, q_idx, kv_idx): | |
| return (q_idx < valid_lens[batch_idx]) & (kv_idx < valid_lens[batch_idx]) | |
| flex_block_mask = create_block_mask(mask_mod, batch_size, 1, seq_len, seq_len, device=device) | |
| return attention_mask_2d, None, flex_block_mask | |
| # SDPA/manual masks only keys. Padding queries still attend to real keys, so | |
| # their outputs stay finite instead of softmaxing over all -inf scores. | |
| attention_mask_4d = attention_mask_2d[:, None, None, :] | |
| return attention_mask_2d, attention_mask_4d, None | |
| def bool_to_additive_mask( | |
| bool_mask: torch.Tensor, | |
| dtype: torch.dtype, | |
| ) -> torch.Tensor: | |
| """Convert a bool mask (True = valid) to a float additive mask (0.0 valid, -inf invalid). | |
| Why this exists: calling `bool_mask.masked_fill(bool_mask.logical_not(), float('-inf'))` | |
| directly on a bool tensor returns a bool tensor because `-inf` casts to `True`. | |
| That silently drops the mask. Always allocate a float tensor first, then fill it. | |
| This helper is the sanctioned way to build an SDPA additive mask from a bool validity mask. | |
| """ | |
| assert bool_mask.dtype == torch.bool, ( | |
| f"bool_to_additive_mask requires a bool tensor, got dtype={bool_mask.dtype}" | |
| ) | |
| additive = torch.zeros_like(bool_mask, dtype=dtype) | |
| additive.masked_fill_(bool_mask.logical_not(), float("-inf")) | |
| return additive | |
| import typing as T | |
| from dataclasses import dataclass, fields | |
| import torch | |
| import torch.nn as nn | |
| import torch.nn.functional as F | |
| class TTTConfig: | |
| lr: float = 4e-4 | |
| steps: int = 30 | |
| ags: int = 16 | |
| batch_size: int = 2 | |
| mask_ratio: float = 0.15 | |
| crop_size: int = 1024 | |
| bert_leave_prob: float = 0.1 | |
| bert_replace_prob: float = 0.1 | |
| optimizer: str = "sgd" | |
| momentum: float = 0.0 | |
| weight_decay: float = 0.0 | |
| seed: int | None = 0 | |
| lora_rank: int = 8 | |
| lora_alpha: float = 32.0 | |
| lora_target_replace_module: str | None = None | |
| lora_target_modules: tuple[str, ...] | None = None | |
| initial_state_reset: bool = True | |
| automatic_best_state_reset: bool = False | |
| eval_each_step: bool = False | |
| gradient_clip: bool = False | |
| gradient_clip_max_norm: float = 1.0 | |
| def from_kwargs(cls, **kwargs: T.Any) -> "TTTConfig": | |
| valid_names = {field.name for field in fields(cls)} | |
| unknown_names = set(kwargs) - valid_names | |
| assert len(unknown_names) == 0, f"Unknown TTTConfig fields: {sorted(unknown_names)}" | |
| return cls(**kwargs) | |
| def merged(self, overrides: T.Mapping[str, T.Any] | "TTTConfig" | None) -> "TTTConfig": | |
| if overrides is None: | |
| return self | |
| if isinstance(overrides, TTTConfig): | |
| return overrides | |
| values = {field.name: self.__dict__[field.name] for field in fields(self)} | |
| for name, value in overrides.items(): | |
| assert name in values, f"Unknown TTTConfig field: {name}" | |
| values[name] = value | |
| return TTTConfig(**values) | |
| def verify(self) -> None: | |
| assert self.lr > 0.0, "TTT learning rate must be positive." | |
| assert self.steps >= 1, "TTT steps must be >= 1." | |
| assert self.ags >= 1, "TTT gradient accumulation steps must be >= 1." | |
| assert self.batch_size >= 1, "TTT batch_size must be >= 1." | |
| assert 0.0 < self.mask_ratio <= 1.0, "TTT mask_ratio must be in (0, 1]." | |
| assert self.crop_size >= 1, "TTT crop_size must be >= 1." | |
| assert self.lora_rank >= 1, "TTT v1 is LoRA-only, so lora_rank must be >= 1." | |
| assert self.lora_alpha > 0.0, "TTT lora_alpha must be positive." | |
| assert self.optimizer in {"adamw", "sgd"}, "TTT optimizer must be 'adamw' or 'sgd'." | |
| assert 0.0 <= self.bert_leave_prob <= 1.0, "bert_leave_prob must be in [0, 1]." | |
| assert 0.0 <= self.bert_replace_prob <= 1.0, "bert_replace_prob must be in [0, 1]." | |
| assert self.bert_leave_prob + self.bert_replace_prob <= 1.0, ( | |
| "bert_leave_prob + bert_replace_prob must be <= 1." | |
| ) | |
| if self.gradient_clip: | |
| assert self.gradient_clip_max_norm > 0.0, "gradient_clip_max_norm must be positive." | |
| class LoraInjectedLinear(nn.Module): | |
| def __init__(self, linear: nn.Module, rank: int, alpha: float) -> None: | |
| super().__init__() | |
| weight = linear._parameters["weight"] | |
| assert weight.ndim == 2, "LoRA can only wrap 2D linear weights." | |
| self.linear = linear | |
| self.linear.requires_grad_(False) | |
| self.rank = rank | |
| self.scale = alpha | |
| in_features = weight.shape[1] | |
| out_features = weight.shape[0] | |
| self.lora_down = nn.Linear(in_features, rank, bias=False, dtype=torch.float32) | |
| self.lora_up = nn.Linear(rank, out_features, bias=False, dtype=torch.float32) | |
| self.lora_down.to(device=weight.device) | |
| self.lora_up.to(device=weight.device) | |
| nn.init.normal_(self.lora_down.weight, std=1.0 / rank) | |
| nn.init.zeros_(self.lora_up.weight) | |
| def weight(self) -> torch.Tensor: | |
| return self.linear._parameters["weight"] | |
| def bias(self) -> torch.Tensor | None: | |
| return self.linear._parameters["bias"] | |
| def forward(self, x: torch.Tensor) -> torch.Tensor: | |
| base = self.linear(x) | |
| delta = self.lora_up(self.lora_down(x.to(dtype=torch.float32))) * self.scale | |
| return base + delta.to(dtype=base.dtype) | |
| class FastPLMTestTimeTrainingMixin: | |
| def init_ttt(self, ttt_config: TTTConfig | T.Mapping[str, T.Any] | None = None) -> None: | |
| base_config = TTTConfig() | |
| self._ttt_cfg = base_config.merged(ttt_config) | |
| self._ttt_cfg.verify() | |
| self._ttt_initialized = False | |
| self._ttt_initial_state: list[dict[str, torch.Tensor]] | None = None | |
| def ttt_config(self) -> TTTConfig: | |
| if "_ttt_cfg" not in self.__dict__: | |
| self.init_ttt() | |
| return self._ttt_cfg | |
| def _ttt_get_trainable_modules(self) -> list[nn.Module]: | |
| return [self] | |
| def _ttt_get_frozen_modules(self) -> list[nn.Module]: | |
| return [] | |
| def _ttt_tokenize( | |
| self, | |
| seq: str | list[str] | None = None, | |
| input_ids: torch.Tensor | None = None, | |
| **kwargs: T.Any, | |
| ) -> torch.Tensor | dict[str, torch.Tensor]: | |
| del kwargs | |
| if input_ids is not None: | |
| return input_ids | |
| assert seq is not None, "Pass either seq or input_ids for TTT." | |
| tokenized = self.tokenizer(seq, return_tensors="pt", padding=True) | |
| return tokenized["input_ids"] | |
| def _ttt_mask_token(self) -> int: | |
| return int(self.tokenizer.mask_token_id) | |
| def _ttt_padding_token(self) -> int: | |
| return int(self.tokenizer.pad_token_id) | |
| def _ttt_replacement_tokens(self, input_ids: torch.Tensor) -> torch.Tensor: | |
| tokenizer = self.tokenizer | |
| special_ids = set(tokenizer.all_special_ids) | |
| vocab_size = int(self.config.vocab_size) | |
| ids = [idx for idx in range(vocab_size) if idx not in special_ids] | |
| assert len(ids) > 0, "TTT replacement token set is empty." | |
| return torch.tensor(ids, device=input_ids.device, dtype=input_ids.dtype) | |
| def _ttt_predict_logits( | |
| self, | |
| batch: torch.Tensor | dict[str, torch.Tensor], | |
| **kwargs: T.Any, | |
| ) -> torch.Tensor: | |
| del kwargs | |
| if isinstance(batch, dict): | |
| output = self(**batch) | |
| return output.logits | |
| attention_mask = batch.ne(self._ttt_padding_token()) | |
| output = self(input_ids=batch, attention_mask=attention_mask) | |
| return output.logits | |
| def _ttt_eval_step( | |
| self, | |
| step: int, | |
| loss: float, | |
| seq: str | list[str] | None = None, | |
| input_ids: torch.Tensor | None = None, | |
| **kwargs: T.Any, | |
| ) -> tuple[dict[str, T.Any], float | None]: | |
| del step, loss, seq, input_ids, kwargs | |
| return {}, None | |
| def _ttt_is_lora_target( | |
| self, | |
| name: str, | |
| full_name: str, | |
| module: nn.Module, | |
| active: bool, | |
| target_modules: tuple[str, ...] | None, | |
| ) -> bool: | |
| if not active: | |
| return False | |
| if isinstance(module, LoraInjectedLinear): | |
| return False | |
| if ( | |
| target_modules is not None | |
| and name not in target_modules | |
| and full_name not in target_modules | |
| ): | |
| return False | |
| if isinstance(module, nn.Linear): | |
| return True | |
| if "weight" not in module._parameters: | |
| return False | |
| weight = module._parameters["weight"] | |
| if weight is None or weight.ndim != 2: | |
| return False | |
| return "Linear" in module.__class__.__name__ | |
| def _ttt_inject_lora(self) -> int: | |
| cfg = self.ttt_config | |
| cfg.verify() | |
| target_class = cfg.lora_target_replace_module | |
| target_modules = cfg.lora_target_modules | |
| wrapped = 0 | |
| def inject(module: nn.Module, prefix: str, active: bool) -> None: | |
| nonlocal wrapped | |
| for name, child in list(module.named_children()): | |
| full_name = f"{prefix}.{name}" if prefix else name | |
| child_active = active | |
| if target_class is not None: | |
| child_active = active or child.__class__.__name__ == target_class | |
| if self._ttt_is_lora_target(name, full_name, child, child_active, target_modules): | |
| setattr( | |
| module, | |
| name, | |
| LoraInjectedLinear(child, rank=cfg.lora_rank, alpha=cfg.lora_alpha), | |
| ) | |
| wrapped += 1 | |
| continue | |
| inject(child, full_name, child_active) | |
| for trainable_module in self._ttt_get_trainable_modules(): | |
| inject(trainable_module, "", target_class is None) | |
| assert wrapped > 0, "TTT LoRA injection did not find any target modules." | |
| return wrapped | |
| def _ttt_lora_modules(self) -> list[LoraInjectedLinear]: | |
| return [module for module in self.modules() if isinstance(module, LoraInjectedLinear)] | |
| def _ttt_lora_parameters(self) -> list[nn.Parameter]: | |
| params: list[nn.Parameter] = [] | |
| for module in self._ttt_lora_modules(): | |
| params.extend(module.lora_down.parameters()) | |
| params.extend(module.lora_up.parameters()) | |
| assert len(params) > 0, "TTT has no LoRA parameters." | |
| return params | |
| def _ttt_snapshot_lora_state(self) -> list[dict[str, torch.Tensor]]: | |
| snapshot = [] | |
| for module in self._ttt_lora_modules(): | |
| snapshot.append( | |
| { | |
| "lora_down.weight": module.lora_down.weight.detach().clone(), | |
| "lora_up.weight": module.lora_up.weight.detach().clone(), | |
| } | |
| ) | |
| assert len(snapshot) > 0, "TTT has no LoRA state to snapshot." | |
| return snapshot | |
| def _ttt_restore_lora_state(self, state: list[dict[str, torch.Tensor]]) -> None: | |
| modules = self._ttt_lora_modules() | |
| assert len(modules) == len(state), "TTT LoRA state/module count mismatch." | |
| with torch.no_grad(): | |
| for module, module_state in zip(modules, state): | |
| module.lora_down.weight.copy_(module_state["lora_down.weight"]) | |
| module.lora_up.weight.copy_(module_state["lora_up.weight"]) | |
| def _ttt_ensure_initialized(self) -> None: | |
| if "_ttt_cfg" not in self.__dict__: | |
| self.init_ttt() | |
| if self._ttt_initialized: | |
| return | |
| self._ttt_inject_lora() | |
| self._ttt_initial_state = self._ttt_snapshot_lora_state() | |
| self._ttt_initialized = True | |
| def ttt_reset(self) -> None: | |
| self._ttt_ensure_initialized() | |
| assert self._ttt_initial_state is not None, "TTT initial state is not available." | |
| self._ttt_restore_lora_state(self._ttt_initial_state) | |
| def _ttt_make_optimizer(self) -> torch.optim.Optimizer: | |
| cfg = self.ttt_config | |
| params = self._ttt_lora_parameters() | |
| if cfg.optimizer == "sgd": | |
| return torch.optim.SGD( | |
| params, | |
| lr=cfg.lr, | |
| momentum=cfg.momentum, | |
| weight_decay=cfg.weight_decay, | |
| ) | |
| return torch.optim.AdamW(params, lr=cfg.lr, weight_decay=cfg.weight_decay) | |
| def _ttt_to_device( | |
| self, | |
| batch: torch.Tensor | dict[str, torch.Tensor], | |
| device: torch.device, | |
| ) -> torch.Tensor | dict[str, torch.Tensor]: | |
| if isinstance(batch, dict): | |
| return {name: tensor.to(device) for name, tensor in batch.items()} | |
| return batch.to(device) | |
| def _ttt_input_ids_from_batch( | |
| self, | |
| batch: torch.Tensor | dict[str, torch.Tensor], | |
| ) -> torch.Tensor: | |
| if isinstance(batch, dict): | |
| return batch["input_ids"] | |
| return batch | |
| def _ttt_set_input_ids( | |
| self, | |
| batch: torch.Tensor | dict[str, torch.Tensor], | |
| input_ids: torch.Tensor, | |
| ) -> torch.Tensor | dict[str, torch.Tensor]: | |
| if isinstance(batch, dict): | |
| updated = dict(batch) | |
| updated["input_ids"] = input_ids | |
| return updated | |
| return input_ids | |
| def _ttt_non_special_mask(self, input_ids: torch.Tensor) -> torch.Tensor: | |
| pad_token = self._ttt_padding_token() | |
| mask = input_ids.ne(pad_token) | |
| special_ids = set(self.tokenizer.all_special_ids) | |
| for special_id in special_ids: | |
| mask = mask & input_ids.ne(int(special_id)) | |
| return mask | |
| def _ttt_sample_crop( | |
| self, | |
| batch: torch.Tensor | dict[str, torch.Tensor], | |
| generator: torch.Generator, | |
| ) -> torch.Tensor | dict[str, torch.Tensor]: | |
| input_ids = self._ttt_input_ids_from_batch(batch) | |
| cfg = self.ttt_config | |
| if input_ids.shape[1] <= cfg.crop_size: | |
| return batch | |
| high = input_ids.shape[1] - cfg.crop_size + 1 | |
| start = int( | |
| torch.randint( | |
| high, | |
| (1,), | |
| generator=generator, | |
| device=input_ids.device, | |
| ).item() | |
| ) | |
| end = start + cfg.crop_size | |
| if isinstance(batch, dict): | |
| cropped = {} | |
| for name, tensor in batch.items(): | |
| if tensor.ndim >= 2 and tensor.shape[1] == input_ids.shape[1]: | |
| cropped[name] = tensor[:, start:end] | |
| else: | |
| cropped[name] = tensor | |
| return cropped | |
| return input_ids[:, start:end] | |
| def _ttt_sample_batch( | |
| self, | |
| tokenized: torch.Tensor | dict[str, torch.Tensor], | |
| generator: torch.Generator, | |
| ) -> tuple[torch.Tensor | dict[str, torch.Tensor], torch.Tensor]: | |
| cfg = self.ttt_config | |
| batch = self._ttt_sample_crop(tokenized, generator) | |
| input_ids = self._ttt_input_ids_from_batch(batch) | |
| rows = torch.randint( | |
| input_ids.shape[0], | |
| (cfg.batch_size,), | |
| generator=generator, | |
| device=input_ids.device, | |
| ) | |
| if isinstance(batch, dict): | |
| sampled: torch.Tensor | dict[str, torch.Tensor] = {} | |
| for name, tensor in batch.items(): | |
| if tensor.ndim >= 1 and tensor.shape[0] == input_ids.shape[0]: | |
| sampled[name] = tensor.index_select(0, rows) | |
| else: | |
| sampled[name] = tensor | |
| else: | |
| sampled = input_ids.index_select(0, rows) | |
| sampled_ids = self._ttt_input_ids_from_batch(sampled) | |
| labels = sampled_ids.clone() | |
| non_special = self._ttt_non_special_mask(sampled_ids) | |
| label_mask = torch.zeros_like(non_special) | |
| for row_idx in range(sampled_ids.shape[0]): | |
| candidate_positions = torch.where(non_special[row_idx])[0] | |
| if candidate_positions.numel() == 0: | |
| continue | |
| num_mask = max(1, int(round(candidate_positions.numel() * cfg.mask_ratio))) | |
| order = torch.randperm( | |
| candidate_positions.numel(), | |
| generator=generator, | |
| device=sampled_ids.device, | |
| ) | |
| chosen = candidate_positions[order[:num_mask]] | |
| label_mask[row_idx, chosen] = True | |
| labels = labels.masked_fill(~label_mask, -100) | |
| masked_ids = sampled_ids.clone() | |
| chosen_positions = torch.where(label_mask) | |
| if chosen_positions[0].numel() > 0: | |
| random_values = torch.rand( | |
| chosen_positions[0].shape, | |
| generator=generator, | |
| device=sampled_ids.device, | |
| ) | |
| leave = random_values < cfg.bert_leave_prob | |
| replace = (random_values >= cfg.bert_leave_prob) & ( | |
| random_values < cfg.bert_leave_prob + cfg.bert_replace_prob | |
| ) | |
| mask = ~(leave | replace) | |
| if mask.any(): | |
| masked_ids[ | |
| chosen_positions[0][mask], | |
| chosen_positions[1][mask], | |
| ] = self._ttt_mask_token() | |
| if replace.any(): | |
| replacement_tokens = self._ttt_replacement_tokens(sampled_ids) | |
| replacement_idx = torch.randint( | |
| replacement_tokens.shape[0], | |
| (int(replace.sum().item()),), | |
| generator=generator, | |
| device=sampled_ids.device, | |
| ) | |
| masked_ids[ | |
| chosen_positions[0][replace], | |
| chosen_positions[1][replace], | |
| ] = replacement_tokens[replacement_idx] | |
| return self._ttt_set_input_ids(sampled, masked_ids), labels | |
| def ttt( | |
| self, | |
| seq: str | list[str] | None = None, | |
| input_ids: torch.Tensor | None = None, | |
| ttt_config: TTTConfig | T.Mapping[str, T.Any] | None = None, | |
| **kwargs: T.Any, | |
| ) -> dict[str, T.Any]: | |
| if ttt_config is not None: | |
| if "_ttt_initialized" in self.__dict__ and self._ttt_initialized: | |
| next_cfg = self.ttt_config.merged(ttt_config) | |
| assert next_cfg.lora_rank == self.ttt_config.lora_rank, ( | |
| "Changing lora_rank after TTT initialization is not supported." | |
| ) | |
| assert next_cfg.lora_alpha == self.ttt_config.lora_alpha, ( | |
| "Changing lora_alpha after TTT initialization is not supported." | |
| ) | |
| assert ( | |
| next_cfg.lora_target_replace_module | |
| == self.ttt_config.lora_target_replace_module | |
| ), "Changing LoRA target class after TTT initialization is not supported." | |
| assert next_cfg.lora_target_modules == self.ttt_config.lora_target_modules, ( | |
| "Changing LoRA target modules after TTT initialization is not supported." | |
| ) | |
| self._ttt_cfg = next_cfg | |
| else: | |
| self.init_ttt(ttt_config) | |
| self._ttt_ensure_initialized() | |
| cfg = self.ttt_config | |
| if cfg.initial_state_reset: | |
| self.ttt_reset() | |
| device = next(self.parameters()).device | |
| tokenized = self._ttt_tokenize(seq=seq, input_ids=input_ids, **kwargs) | |
| tokenized = self._ttt_to_device(tokenized, device) | |
| generator_device = device if device.type == "cuda" else torch.device("cpu") | |
| generator = torch.Generator(device=generator_device) | |
| if cfg.seed is not None: | |
| generator.manual_seed(cfg.seed) | |
| module_modes = {module: module.training for module in self.modules()} | |
| requires_grad = {param: param.requires_grad for param in self.parameters()} | |
| losses: list[float] = [] | |
| step_metrics: list[dict[str, T.Any]] = [] | |
| best_state: list[dict[str, torch.Tensor]] | None = None | |
| best_metric: float | None = None | |
| best_step = 0 | |
| try: | |
| self.train() | |
| for param in self.parameters(): | |
| param.requires_grad_(False) | |
| for param in self._ttt_lora_parameters(): | |
| param.requires_grad_(True) | |
| optimizer = self._ttt_make_optimizer() | |
| optimizer.zero_grad(set_to_none=True) | |
| total_micro_steps = cfg.steps * cfg.ags | |
| for micro_step in range(total_micro_steps): | |
| batch, labels = self._ttt_sample_batch(tokenized, generator) | |
| logits = self._ttt_predict_logits(batch, **kwargs) | |
| labels = labels.to(device=logits.device) | |
| loss = F.cross_entropy( | |
| logits.reshape(-1, logits.shape[-1]), | |
| labels.reshape(-1), | |
| ignore_index=-100, | |
| ) | |
| (loss / cfg.ags).backward() | |
| if (micro_step + 1) % cfg.ags != 0: | |
| continue | |
| if cfg.gradient_clip: | |
| torch.nn.utils.clip_grad_norm_( | |
| self._ttt_lora_parameters(), | |
| cfg.gradient_clip_max_norm, | |
| ) | |
| optimizer.step() | |
| optimizer.zero_grad(set_to_none=True) | |
| step = (micro_step + 1) // cfg.ags | |
| loss_value = float(loss.detach().item()) | |
| losses.append(loss_value) | |
| if cfg.eval_each_step: | |
| metrics, metric = self._ttt_eval_step( | |
| step=step, | |
| loss=loss_value, | |
| seq=seq, | |
| input_ids=input_ids, | |
| **kwargs, | |
| ) | |
| if len(metrics) > 0: | |
| step_metrics.append(metrics) | |
| if metric is not None and ( | |
| best_metric is None or metric > best_metric | |
| ): | |
| best_metric = metric | |
| best_step = step | |
| best_state = self._ttt_snapshot_lora_state() | |
| if cfg.automatic_best_state_reset and best_state is not None: | |
| self._ttt_restore_lora_state(best_state) | |
| finally: | |
| for param, value in requires_grad.items(): | |
| param.requires_grad_(value) | |
| for module, training in module_modes.items(): | |
| module.train(training) | |
| return { | |
| "losses": losses, | |
| "step_metrics": step_metrics, | |
| "best_step": best_step, | |
| "best_metric": best_metric, | |
| } | |
| import torch | |
| import torch.nn as nn | |
| from torch.nn import functional as F | |
| from typing import Any, Dict, List, Optional, Tuple | |
| from einops import rearrange | |
| from dataclasses import dataclass | |
| from transformers import PreTrainedModel, PretrainedConfig, EsmTokenizer | |
| from transformers.modeling_outputs import ModelOutput | |
| from transformers.models.esm.modeling_esm import ( | |
| EsmIntermediate, | |
| EsmOutput, | |
| EsmPooler, | |
| EsmLMHead, | |
| EsmSelfOutput, | |
| EsmClassificationHead, | |
| EsmContactPredictionHead, | |
| EsmEmbeddings, | |
| RotaryEmbedding, | |
| ) | |
| class FastEsmEncoderOutput(ModelOutput): | |
| last_hidden_state: Optional[torch.Tensor] = None | |
| hidden_states: Optional[Tuple[torch.Tensor, ...]] = None | |
| attentions: Optional[Tuple[torch.Tensor, ...]] = None | |
| s_max: Optional[Tuple[List[torch.Tensor], ...]] = None | |
| class EsmMaskedLMOutput(ModelOutput): | |
| loss: Optional[torch.Tensor] = None | |
| logits: Optional[torch.Tensor] = None | |
| last_hidden_state: Optional[torch.Tensor] = None | |
| hidden_states: Optional[Tuple[torch.Tensor, ...]] = None | |
| attentions: Optional[Tuple[torch.Tensor, ...]] = None | |
| s_max: Optional[Tuple[List[torch.Tensor], ...]] = None | |
| class FastEsmConfig(PretrainedConfig): | |
| model_type = "fast_esm" | |
| def __init__( | |
| self, | |
| vocab_size: int = None, | |
| mask_token_id: int = None, | |
| pad_token_id: int = None, | |
| hidden_size: int = 768, | |
| num_hidden_layers: int = 12, | |
| num_attention_heads: int = 12, | |
| intermediate_size: int = 3072, | |
| hidden_dropout_prob: float = 0.1, | |
| attention_probs_dropout_prob: float = 0.1, | |
| max_position_embeddings: int = 1026, | |
| initializer_range: float = 0.02, | |
| layer_norm_eps: float = 1e-12, | |
| position_embedding_type: str = "rotary", | |
| emb_layer_norm_before: bool = None, | |
| token_dropout: bool = True, | |
| attn_backend: str = "sdpa", | |
| **kwargs, | |
| ): | |
| super().__init__( | |
| pad_token_id=pad_token_id, | |
| mask_token_id=mask_token_id, | |
| **kwargs, | |
| ) | |
| self.vocab_size = vocab_size | |
| self.hidden_size = hidden_size | |
| self.num_hidden_layers = num_hidden_layers | |
| self.num_attention_heads = num_attention_heads | |
| self.intermediate_size = intermediate_size | |
| self.hidden_dropout_prob = hidden_dropout_prob | |
| self.attention_probs_dropout_prob = attention_probs_dropout_prob | |
| self.max_position_embeddings = max_position_embeddings | |
| self.initializer_range = initializer_range | |
| self.layer_norm_eps = layer_norm_eps | |
| self.position_embedding_type = position_embedding_type | |
| self.emb_layer_norm_before = emb_layer_norm_before | |
| self.tie_word_embeddings = False | |
| self.token_dropout = token_dropout | |
| self.attn_backend = attn_backend | |
| def to_dict(self) -> Dict[str, Any]: | |
| """ | |
| Serializes this instance to a Python dictionary. Override the default [`~PretrainedConfig.to_dict`]. | |
| Returns: | |
| `Dict[str, any]`: Dictionar y of all the attributes that make up this configuration instance, | |
| """ | |
| output = super().to_dict() | |
| return output | |
| class EsmSelfAttention(nn.Module): | |
| def __init__(self, config, position_embedding_type: Optional[str] = None): | |
| super().__init__() | |
| assert config.hidden_size % config.num_attention_heads == 0, ( | |
| f"The hidden size ({config.hidden_size}) is not a multiple of the number of attention " | |
| f"heads ({config.num_attention_heads})" | |
| ) | |
| self.num_attention_heads = config.num_attention_heads | |
| self.attention_head_size = int(config.hidden_size / config.num_attention_heads) | |
| self.all_head_size = self.num_attention_heads * self.attention_head_size | |
| self.query = nn.Linear(config.hidden_size, self.all_head_size) | |
| self.key = nn.Linear(config.hidden_size, self.all_head_size) | |
| self.value = nn.Linear(config.hidden_size, self.all_head_size) | |
| self.scale = self.attention_head_size**-0.5 | |
| self.dropout_prob = config.attention_probs_dropout_prob | |
| self.config = config | |
| self.attn_backend = resolve_attention_backend(config.attn_backend) | |
| self.position_embedding_type = position_embedding_type or config.position_embedding_type | |
| self.rotary_embeddings = None | |
| if self.position_embedding_type == "rotary": | |
| self.rotary_embeddings = RotaryEmbedding(dim=self.attention_head_size) | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask_2d: Optional[torch.Tensor] = None, | |
| attention_mask_4d: Optional[torch.Tensor] = None, | |
| flex_block_mask: Optional[BlockMask] = None, | |
| output_attentions: bool = False, | |
| output_s_max: bool = False, | |
| ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[List[torch.Tensor]]]: | |
| batch_size, seq_length = hidden_states.shape[:-1] | |
| hidden_shape = (batch_size, seq_length, -1, self.attention_head_size) | |
| query_BHLD = self.query(hidden_states).view(hidden_shape).transpose(1, 2) | |
| key_BHLD = self.key(hidden_states).view(hidden_shape).transpose(1, 2) | |
| value_BHLD = self.value(hidden_states).view(hidden_shape).transpose(1, 2) | |
| query_BHLD = query_BHLD * self.scale | |
| if self.position_embedding_type == "rotary": | |
| query_BHLD, key_BHLD = self.rotary_embeddings(query_BHLD, key_BHLD) | |
| attn_output, attn_weights, s_max = self._attn( | |
| query_BHLD, key_BHLD, value_BHLD, | |
| attention_mask_2d=attention_mask_2d, | |
| attention_mask_4d=attention_mask_4d, | |
| flex_block_mask=flex_block_mask, | |
| output_attentions=output_attentions, | |
| output_s_max=output_s_max, | |
| ) | |
| return attn_output, attn_weights, s_max | |
| def _attn( | |
| self, | |
| query_BHLD: torch.Tensor, | |
| key_BHLD: torch.Tensor, | |
| value_BHLD: torch.Tensor, | |
| attention_mask_2d: Optional[torch.Tensor] = None, | |
| attention_mask_4d: Optional[torch.Tensor] = None, | |
| flex_block_mask: Optional[BlockMask] = None, | |
| output_attentions: bool = False, | |
| output_s_max: bool = False, | |
| ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[List[torch.Tensor]]]: | |
| if output_attentions: | |
| return self._manual_attn(query_BHLD, key_BHLD, value_BHLD, attention_mask_4d, output_s_max) | |
| if self.attn_backend == AttentionBackend.KERNELS_FLASH: | |
| attn_output, attn_weights = self._kernels_flash_attn(query_BHLD, key_BHLD, value_BHLD, attention_mask_2d) | |
| elif self.attn_backend == AttentionBackend.FLEX: | |
| attn_output, attn_weights = self._flex_attn(query_BHLD, key_BHLD, value_BHLD, flex_block_mask) | |
| elif self.attn_backend == AttentionBackend.SDPA: | |
| attn_output, attn_weights = self._sdpa_attn(query_BHLD, key_BHLD, value_BHLD, attention_mask_4d) | |
| else: | |
| raise AssertionError(f"Unsupported resolved backend: {self.attn_backend}") | |
| s_max = self._compute_s_max(query_BHLD, key_BHLD) if output_s_max else None | |
| return attn_output, attn_weights, s_max | |
| def _compute_s_max(self, query_BHLD: torch.Tensor, key_BHLD: torch.Tensor) -> List[torch.Tensor]: | |
| q_norm = torch.linalg.vector_norm(query_BHLD, dim=-1) | |
| k_norm = torch.linalg.vector_norm(key_BHLD, dim=-1) | |
| s_max_bound = (q_norm.max(dim=-1).values * k_norm.max(dim=-1).values).max(dim=0).values | |
| return [s_max_bound[h] for h in range(self.num_attention_heads)] | |
| def _manual_attn( | |
| self, | |
| query_BHLD: torch.Tensor, | |
| key_BHLD: torch.Tensor, | |
| value_BHLD: torch.Tensor, | |
| attention_mask_4d: Optional[torch.Tensor] = None, | |
| output_s_max: bool = False, | |
| ) -> Tuple[torch.Tensor, torch.Tensor, Optional[List[torch.Tensor]]]: | |
| attn_weights = torch.matmul(query_BHLD, key_BHLD.transpose(-1, -2)) | |
| if attention_mask_4d is not None: | |
| attn_weights = attn_weights.masked_fill(attention_mask_4d.logical_not(), float("-inf")) | |
| attn_weights = F.softmax(attn_weights, dim=-1) | |
| if self.dropout_prob > 0 and self.training: | |
| attn_weights = F.dropout(attn_weights, p=self.dropout_prob, training=self.training) | |
| context_BHLD = torch.matmul(attn_weights, value_BHLD) | |
| attn_output = rearrange(context_BHLD, "b h s d -> b s (h d)") | |
| s_max = self._compute_s_max(query_BHLD, key_BHLD) if output_s_max else None | |
| return attn_output, attn_weights, s_max | |
| def _kernels_flash_attn( | |
| self, | |
| query_BHLD: torch.Tensor, | |
| key_BHLD: torch.Tensor, | |
| value_BHLD: torch.Tensor, | |
| attention_mask_2d: Optional[torch.Tensor] = None, | |
| ) -> Tuple[torch.Tensor, None]: | |
| query_BLHD = query_BHLD.transpose(1, 2).contiguous() | |
| key_BLHD = key_BHLD.transpose(1, 2).contiguous() | |
| value_BLHD = value_BHLD.transpose(1, 2).contiguous() | |
| # Q has been pre-scaled by self.scale = 1/sqrt(head_dim) in forward(). | |
| # Pass softmax_scale=1.0 to prevent the kernel from applying its default | |
| # 1/sqrt(head_dim) scale on top (which would yield effective scale | |
| # 1/head_dim and break parity vs sdpa). | |
| attn_output = kernels_flash_attention_func( | |
| query_states=query_BLHD, key_states=key_BLHD, value_states=value_BLHD, | |
| attention_mask_2d=attention_mask_2d, causal=False, | |
| softmax_scale=1.0, | |
| ) | |
| return rearrange(attn_output, "b s h d -> b s (h d)"), None | |
| def _flex_attn( | |
| self, | |
| query_BHLD: torch.Tensor, | |
| key_BHLD: torch.Tensor, | |
| value_BHLD: torch.Tensor, | |
| flex_block_mask: Optional[BlockMask] = None, | |
| ) -> Tuple[torch.Tensor, None]: | |
| assert flex_attention is not None, "Flex attention is not available in this environment." | |
| fn = _get_flex_attention_fn() | |
| context_BHLD = fn(query_BHLD, key_BHLD, value_BHLD, block_mask=flex_block_mask, scale=1.0) | |
| return rearrange(context_BHLD, "b h s d -> b s (h d)"), None | |
| def _sdpa_attn( | |
| self, | |
| query_BHLD: torch.Tensor, | |
| key_BHLD: torch.Tensor, | |
| value_BHLD: torch.Tensor, | |
| attention_mask_4d: Optional[torch.Tensor] = None, | |
| ) -> Tuple[torch.Tensor, None]: | |
| context_BHLD = F.scaled_dot_product_attention( | |
| query_BHLD, key_BHLD, value_BHLD, | |
| attn_mask=attention_mask_4d, | |
| dropout_p=self.dropout_prob if self.training else 0.0, | |
| scale=1.0, | |
| ) | |
| return rearrange(context_BHLD, "b h s d -> b s (h d)"), None | |
| class EsmAttention(nn.Module): | |
| def __init__(self, config): | |
| super().__init__() | |
| self.self = EsmSelfAttention(config) | |
| self.output = EsmSelfOutput(config) | |
| self.LayerNorm = nn.LayerNorm(config.hidden_size, eps=config.layer_norm_eps) | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask_2d: Optional[torch.Tensor] = None, | |
| attention_mask_4d: Optional[torch.Tensor] = None, | |
| flex_block_mask: Optional[BlockMask] = None, | |
| output_attentions: bool = False, | |
| output_s_max: bool = False, | |
| ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[List[torch.Tensor]]]: | |
| hidden_states_ln = self.LayerNorm(hidden_states) | |
| attn_output, attn_weights, s_max = self.self( | |
| hidden_states_ln, | |
| attention_mask_2d=attention_mask_2d, | |
| attention_mask_4d=attention_mask_4d, | |
| flex_block_mask=flex_block_mask, | |
| output_attentions=output_attentions, | |
| output_s_max=output_s_max, | |
| ) | |
| attention_output = self.output(attn_output, hidden_states) | |
| return attention_output, attn_weights, s_max | |
| class EsmLayer(nn.Module): | |
| def __init__(self, config): | |
| super().__init__() | |
| self.chunk_size_feed_forward = config.chunk_size_feed_forward | |
| self.seq_len_dim = 1 | |
| self.attention = EsmAttention(config) | |
| self.intermediate = EsmIntermediate(config) | |
| self.output = EsmOutput(config) | |
| self.LayerNorm = nn.LayerNorm(config.hidden_size, eps=config.layer_norm_eps) | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask_2d: Optional[torch.Tensor] = None, | |
| attention_mask_4d: Optional[torch.Tensor] = None, | |
| flex_block_mask: Optional[BlockMask] = None, | |
| output_attentions: bool = False, | |
| output_s_max: bool = False, | |
| ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[List[torch.Tensor]]]: | |
| attention_output, attn_weights, s_max = self.attention( | |
| hidden_states, | |
| attention_mask_2d=attention_mask_2d, | |
| attention_mask_4d=attention_mask_4d, | |
| flex_block_mask=flex_block_mask, | |
| output_attentions=output_attentions, | |
| output_s_max=output_s_max, | |
| ) | |
| layer_output = self.feed_forward_chunk(attention_output) | |
| return layer_output, attn_weights, s_max | |
| def feed_forward_chunk(self, attention_output): | |
| attention_output_ln = self.LayerNorm(attention_output) | |
| intermediate_output = self.intermediate(attention_output_ln) | |
| layer_output = self.output(intermediate_output, attention_output) | |
| return layer_output | |
| class EsmEncoder(nn.Module): | |
| def __init__(self, config): | |
| super().__init__() | |
| self.config = config | |
| self.attention_backend = resolve_attention_backend(config.attn_backend) | |
| self.layer = nn.ModuleList([EsmLayer(config) for _ in range(config.num_hidden_layers)]) | |
| self.emb_layer_norm_after = nn.LayerNorm(config.hidden_size, eps=config.layer_norm_eps) | |
| self.gradient_checkpointing = False | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| output_hidden_states: bool = False, | |
| output_attentions: bool = False, | |
| output_s_max: bool = False, | |
| ) -> FastEsmEncoderOutput: | |
| all_hidden_states = () if output_hidden_states else None | |
| all_attentions = () if output_attentions else None | |
| full_s_max = () if output_s_max else None | |
| attention_mask_2d, attention_mask_4d, flex_block_mask = get_attention_mask( | |
| effective_backend=self.attention_backend, | |
| batch_size=hidden_states.shape[0], | |
| seq_len=hidden_states.shape[1], | |
| device=hidden_states.device, | |
| attention_mask=attention_mask, | |
| ) | |
| for layer_module in self.layer: | |
| if output_hidden_states: | |
| all_hidden_states = all_hidden_states + (hidden_states,) | |
| if self.gradient_checkpointing and self.training: | |
| hidden_states, attn_weights, s_max = self._gradient_checkpointing_func( | |
| layer_module.__call__, | |
| hidden_states, | |
| attention_mask_2d, | |
| attention_mask_4d, | |
| flex_block_mask, | |
| output_attentions, | |
| output_s_max, | |
| ) | |
| else: | |
| hidden_states, attn_weights, s_max = layer_module( | |
| hidden_states, | |
| attention_mask_2d=attention_mask_2d, | |
| attention_mask_4d=attention_mask_4d, | |
| flex_block_mask=flex_block_mask, | |
| output_attentions=output_attentions, | |
| output_s_max=output_s_max, | |
| ) | |
| if all_attentions is not None: | |
| all_attentions = all_attentions + (attn_weights,) | |
| if full_s_max is not None: | |
| full_s_max = full_s_max + (s_max,) | |
| if self.emb_layer_norm_after: | |
| hidden_states = self.emb_layer_norm_after(hidden_states) | |
| if output_hidden_states: | |
| all_hidden_states = all_hidden_states + (hidden_states,) | |
| return FastEsmEncoderOutput( | |
| last_hidden_state=hidden_states, | |
| hidden_states=all_hidden_states, | |
| attentions=all_attentions, | |
| s_max=full_s_max, | |
| ) | |
| class FastEsmPreTrainedModel(PreTrainedModel): | |
| """ | |
| An abstract class to handle weights initialization and a simple interface for downloading and loading pretrained | |
| models. | |
| """ | |
| config_class = FastEsmConfig | |
| base_model_prefix = "fastesm" | |
| supports_gradient_checkpointing = True | |
| tokenizer = EsmTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D") | |
| all_tied_weights_keys = {} | |
| def is_remote_code(cls) -> bool: | |
| # Prevent post-load reinitialization of tensors already loaded from checkpoints. | |
| return True | |
| def _init_weights(self, module: nn.Module) -> None: | |
| std = self.config.initializer_range | |
| if isinstance(module, nn.Linear): | |
| module.weight.data.normal_(mean=0.0, std=std) | |
| if module.bias is not None: | |
| module.bias.data.zero_() | |
| elif isinstance(module, nn.Embedding): | |
| module.weight.data.normal_(mean=0.0, std=std) | |
| if module.padding_idx is not None: | |
| module.weight.data[module.padding_idx].zero_() | |
| def post_init(self) -> None: | |
| super().post_init() | |
| def get_output_embeddings(self): | |
| # NOTE: get_output_embeddings() must return None to prevent accidental weight tying. | |
| # See e.g. https://github.com/huggingface/transformers/pull/39339#discussion_r2219126400 | |
| return None | |
| def attn_backend(self) -> str: | |
| return self.config.attn_backend | |
| def attn_backend(self, backend: str) -> None: | |
| assert backend in VALID_ATTENTION_BACKENDS, f"Unsupported attn_backend: {backend}. Expected one of {VALID_ATTENTION_BACKENDS}." | |
| self.config.attn_backend = backend | |
| resolved = resolve_attention_backend(backend) | |
| for module in self.modules(): | |
| if isinstance(module, EsmEncoder): | |
| module.attention_backend = resolved | |
| elif isinstance(module, EsmSelfAttention): | |
| module.attn_backend = resolved | |
| class FAST_ESM_ENCODER(FastEsmPreTrainedModel, EmbeddingMixin): | |
| def __init__(self, config, add_pooling_layer: Optional[bool] = True, **kwargs): | |
| FastEsmPreTrainedModel.__init__(self, config, **kwargs) | |
| self.config = config | |
| self.embeddings = EsmEmbeddings(config) | |
| self.encoder = EsmEncoder(config) | |
| self.contact_head = EsmContactPredictionHead( | |
| in_features=config.num_hidden_layers * config.num_attention_heads, bias=True | |
| ) | |
| # Initialize weights and apply final processing | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.embeddings.word_embeddings | |
| def set_input_embeddings(self, value): | |
| self.embeddings.word_embeddings = value | |
| def _embed( | |
| self, | |
| input_ids: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| ) -> torch.Tensor: | |
| token_embedding_output = self.embeddings(input_ids, attention_mask=attention_mask) | |
| output_hidden_states = store_all_hidden_states or hidden_state_index != -1 | |
| encoder_outputs = self.encoder( | |
| token_embedding_output, | |
| attention_mask=attention_mask, | |
| output_hidden_states=output_hidden_states, | |
| output_attentions=False, | |
| ) | |
| return select_hidden_state_embeddings( | |
| encoder_outputs.last_hidden_state, | |
| encoder_outputs.hidden_states, | |
| hidden_state_index=hidden_state_index, | |
| store_all_hidden_states=store_all_hidden_states, | |
| ) | |
| def predict_contacts(self, input_ids: torch.Tensor, attention_mask: torch.Tensor) -> torch.Tensor: | |
| attns = self(input_ids, attention_mask=attention_mask, output_attentions=True).attentions | |
| attns = torch.stack(attns, dim=1) | |
| attns *= attention_mask.unsqueeze(1).unsqueeze(2).unsqueeze(3) | |
| attns *= attention_mask.unsqueeze(1).unsqueeze(2).unsqueeze(4) | |
| return self.contact_head(input_ids, attns) | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.Tensor] = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.Tensor] = None, | |
| inputs_embeds: Optional[torch.Tensor] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| output_s_max: Optional[bool] = False, | |
| return_dict: Optional[bool] = None, | |
| ) -> FastEsmEncoderOutput: | |
| output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions | |
| output_hidden_states = output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states | |
| if input_ids is not None and inputs_embeds is not None: | |
| raise ValueError("You cannot specify both input_ids and inputs_embeds at the same time") | |
| elif input_ids is not None: | |
| self.warn_if_padding_and_no_attention_mask(input_ids, attention_mask) | |
| elif inputs_embeds is None: | |
| raise ValueError("You have to specify either input_ids or inputs_embeds") | |
| token_embedding_output = self.embeddings( | |
| input_ids=input_ids, | |
| position_ids=position_ids, | |
| attention_mask=attention_mask, | |
| inputs_embeds=inputs_embeds, | |
| ) | |
| encoder_outputs = self.encoder( | |
| token_embedding_output, | |
| attention_mask=attention_mask, | |
| output_hidden_states=output_hidden_states, | |
| output_attentions=output_attentions, | |
| output_s_max=output_s_max, | |
| ) | |
| return FastEsmEncoderOutput( | |
| last_hidden_state=encoder_outputs.last_hidden_state, | |
| hidden_states=encoder_outputs.hidden_states, | |
| attentions=encoder_outputs.attentions, | |
| s_max=encoder_outputs.s_max, | |
| ) | |
| class FastEsmModel(FastEsmPreTrainedModel, EmbeddingMixin): | |
| def __init__(self, config, add_pooling_layer: Optional[bool] = True, **kwargs): | |
| FastEsmPreTrainedModel.__init__(self, config, **kwargs) | |
| self.config = config | |
| self.esm = FAST_ESM_ENCODER(config) | |
| self.pooler = EsmPooler(config) if add_pooling_layer else None | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.esm.embeddings.word_embeddings | |
| def set_input_embeddings(self, value): | |
| self.esm.embeddings.word_embeddings = value | |
| def _embed( | |
| self, | |
| input_ids: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| ) -> torch.Tensor: | |
| return self.esm._embed( | |
| input_ids, | |
| attention_mask, | |
| hidden_state_index=hidden_state_index, | |
| store_all_hidden_states=store_all_hidden_states, | |
| ) | |
| def predict_contacts(self, input_ids: torch.Tensor, attention_mask: torch.Tensor) -> torch.Tensor: | |
| return self.esm.predict_contacts(input_ids, attention_mask=attention_mask) | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.Tensor] = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.Tensor] = None, | |
| inputs_embeds: Optional[torch.Tensor] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| output_s_max: Optional[bool] = False, | |
| return_dict: Optional[bool] = None, | |
| **kwargs, | |
| ) -> FastEsmEncoderOutput: | |
| output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions | |
| output_hidden_states = output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states | |
| outputs = self.esm( | |
| input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| inputs_embeds=inputs_embeds, | |
| output_hidden_states=output_hidden_states, | |
| output_attentions=output_attentions, | |
| output_s_max=output_s_max, | |
| ) | |
| sequence_output = outputs.last_hidden_state | |
| pooled_output = self.pooler(sequence_output) if self.pooler is not None else None | |
| return FastEsmEncoderOutput( | |
| last_hidden_state=sequence_output, | |
| hidden_states=outputs.hidden_states, | |
| attentions=outputs.attentions, | |
| s_max=outputs.s_max, | |
| ) | |
| class FastEsmForMaskedLM(FastPLMTestTimeTrainingMixin, FastEsmPreTrainedModel, EmbeddingMixin): | |
| def __init__(self, config, **kwargs): | |
| FastEsmPreTrainedModel.__init__(self, config, **kwargs) | |
| self.esm = FAST_ESM_ENCODER(config, add_pooling_layer=False) | |
| self.lm_head = EsmLMHead(config) | |
| self.loss_fct = nn.CrossEntropyLoss() | |
| self.post_init() | |
| self.init_ttt({"lora_target_replace_module": "EsmAttention"}) | |
| def get_input_embeddings(self): | |
| return self.esm.embeddings.word_embeddings | |
| def get_output_embeddings(self): | |
| return self.lm_head.decoder | |
| def set_output_embeddings(self, new_embeddings): | |
| self.lm_head.decoder = new_embeddings | |
| def _embed( | |
| self, | |
| input_ids: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| ) -> torch.Tensor: | |
| return self.esm._embed( | |
| input_ids, | |
| attention_mask, | |
| hidden_state_index=hidden_state_index, | |
| store_all_hidden_states=store_all_hidden_states, | |
| ) | |
| def predict_contacts(self, input_ids: torch.Tensor, attention_mask: torch.Tensor) -> torch.Tensor: | |
| return self.esm.predict_contacts(input_ids, attention_mask=attention_mask) | |
| def _ttt_get_trainable_modules(self) -> list[nn.Module]: | |
| return [self.esm] | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.Tensor] = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.Tensor] = None, | |
| inputs_embeds: Optional[torch.Tensor] = None, | |
| labels: Optional[torch.Tensor] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| output_s_max: Optional[bool] = False, | |
| return_dict: Optional[bool] = None, | |
| **kwargs, | |
| ) -> EsmMaskedLMOutput: | |
| outputs = self.esm( | |
| input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| inputs_embeds=inputs_embeds, | |
| output_hidden_states=output_hidden_states, | |
| output_attentions=output_attentions, | |
| output_s_max=output_s_max, | |
| ) | |
| sequence_output = outputs.last_hidden_state | |
| prediction_scores = self.lm_head(sequence_output) | |
| loss = None | |
| if labels is not None: | |
| labels = labels.to(prediction_scores.device) | |
| loss = self.loss_fct(prediction_scores.view(-1, self.config.vocab_size), labels.view(-1)) | |
| return EsmMaskedLMOutput( | |
| loss=loss, | |
| logits=prediction_scores, | |
| last_hidden_state=sequence_output, | |
| hidden_states=outputs.hidden_states, | |
| attentions=outputs.attentions, | |
| s_max=outputs.s_max, | |
| ) | |
| class FastEsmForSequenceClassification(FastEsmPreTrainedModel, EmbeddingMixin): | |
| def __init__(self, config, **kwargs): | |
| FastEsmPreTrainedModel.__init__(self, config, **kwargs) | |
| self.num_labels = config.num_labels | |
| self.config = config | |
| self.esm = FAST_ESM_ENCODER(config, add_pooling_layer=False) | |
| self.classifier = EsmClassificationHead(config) | |
| self.mse = nn.MSELoss() | |
| self.ce = nn.CrossEntropyLoss() | |
| self.bce = nn.BCEWithLogitsLoss() | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.esm.embeddings.word_embeddings | |
| def _embed( | |
| self, | |
| input_ids: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| ) -> torch.Tensor: | |
| return self.esm._embed( | |
| input_ids, | |
| attention_mask, | |
| hidden_state_index=hidden_state_index, | |
| store_all_hidden_states=store_all_hidden_states, | |
| ) | |
| def predict_contacts(self, input_ids: torch.Tensor, attention_mask: torch.Tensor) -> torch.Tensor: | |
| return self.esm.predict_contacts(input_ids, attention_mask=attention_mask) | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.Tensor] = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.Tensor] = None, | |
| inputs_embeds: Optional[torch.Tensor] = None, | |
| labels: Optional[torch.Tensor] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| output_s_max: Optional[bool] = False, | |
| return_dict: Optional[bool] = None, | |
| **kwargs, | |
| ) -> EsmMaskedLMOutput: | |
| outputs = self.esm( | |
| input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| inputs_embeds=inputs_embeds, | |
| output_attentions=output_attentions, | |
| output_hidden_states=output_hidden_states, | |
| output_s_max=output_s_max, | |
| ) | |
| sequence_output = outputs.last_hidden_state | |
| logits = self.classifier(sequence_output) | |
| loss = None | |
| if labels is not None: | |
| labels = labels.to(logits.device) | |
| if self.config.problem_type is None: | |
| if self.num_labels == 1: | |
| self.config.problem_type = "regression" | |
| elif self.num_labels > 1 and (labels.dtype == torch.long or labels.dtype == torch.int): | |
| self.config.problem_type = "single_label_classification" | |
| else: | |
| self.config.problem_type = "multi_label_classification" | |
| if self.config.problem_type == "regression": | |
| if self.num_labels == 1: | |
| loss = self.mse(logits.squeeze(), labels.squeeze()) | |
| else: | |
| loss = self.mse(logits, labels) | |
| elif self.config.problem_type == "single_label_classification": | |
| loss = self.ce(logits.view(-1, self.num_labels), labels.view(-1)) | |
| elif self.config.problem_type == "multi_label_classification": | |
| loss = self.bce(logits, labels) | |
| return EsmMaskedLMOutput( | |
| loss=loss, | |
| logits=logits, | |
| last_hidden_state=sequence_output, | |
| hidden_states=outputs.hidden_states, | |
| attentions=outputs.attentions, | |
| s_max=outputs.s_max, | |
| ) | |
| class FastEsmForTokenClassification(FastEsmPreTrainedModel, EmbeddingMixin): | |
| def __init__(self, config, **kwargs): | |
| FastEsmPreTrainedModel.__init__(self, config, **kwargs) | |
| self.num_labels = config.num_labels | |
| self.esm = FAST_ESM_ENCODER(config, add_pooling_layer=False) | |
| self.dropout = nn.Dropout(config.hidden_dropout_prob) | |
| self.classifier = nn.Linear(config.hidden_size, config.num_labels) | |
| self.loss_fct = nn.CrossEntropyLoss() | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.esm.embeddings.word_embeddings | |
| def _embed( | |
| self, | |
| input_ids: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| hidden_state_index: int = -1, | |
| store_all_hidden_states: bool = False, | |
| ) -> torch.Tensor: | |
| return self.esm._embed( | |
| input_ids, | |
| attention_mask, | |
| hidden_state_index=hidden_state_index, | |
| store_all_hidden_states=store_all_hidden_states, | |
| ) | |
| def predict_contacts(self, input_ids: torch.Tensor, attention_mask: torch.Tensor) -> torch.Tensor: | |
| return self.esm.predict_contacts(input_ids, attention_mask=attention_mask) | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.Tensor] = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.Tensor] = None, | |
| inputs_embeds: Optional[torch.Tensor] = None, | |
| labels: Optional[torch.Tensor] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| output_s_max: Optional[bool] = False, | |
| return_dict: Optional[bool] = None, | |
| **kwargs, | |
| ) -> EsmMaskedLMOutput: | |
| outputs = self.esm( | |
| input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| inputs_embeds=inputs_embeds, | |
| output_attentions=output_attentions, | |
| output_hidden_states=output_hidden_states, | |
| output_s_max=output_s_max, | |
| ) | |
| sequence_output = outputs.last_hidden_state | |
| sequence_output = self.dropout(sequence_output) | |
| logits = self.classifier(sequence_output) | |
| loss = None | |
| if labels is not None: | |
| labels = labels.to(logits.device) | |
| loss = self.loss_fct(logits.view(-1, self.num_labels), labels.view(-1)) | |
| return EsmMaskedLMOutput( | |
| loss=loss, | |
| logits=logits, | |
| last_hidden_state=sequence_output, | |
| hidden_states=outputs.hidden_states, | |
| attentions=outputs.attentions, | |
| s_max=outputs.s_max, | |
| ) | |
| if __name__ == "__main__": | |
| import random | |
| import torch | |
| from torch import Tensor | |
| from transformers import EsmTokenizer | |
| def print_tensor_shapes(prefix: str, obj): | |
| if isinstance(obj, Tensor): | |
| print(f"{prefix}{obj.shape}") | |
| elif isinstance(obj, dict): | |
| for name, value in obj.items(): | |
| print_tensor_shapes(f"{prefix}{name}.", value) | |
| elif isinstance(obj, list): | |
| for idx, value in enumerate(obj): | |
| print_tensor_shapes(f"{prefix}[{idx}].", value) | |
| elif isinstance(obj, tuple): | |
| for idx, value in enumerate(obj): | |
| print_tensor_shapes(f"{prefix}[{idx}].", value) | |
| elif hasattr(obj, "__dict__"): | |
| for name, value in vars(obj).items(): | |
| if name.startswith("_"): | |
| continue | |
| print_tensor_shapes(f"{prefix}{name}.", value) | |
| else: | |
| print(f"{prefix}{type(obj)}") | |
| random.seed(0) | |
| torch.manual_seed(0) | |
| tokenizer = EsmTokenizer.from_pretrained("facebook/esm2_t6_8M_UR50D") | |
| num_attention_heads = random.choice([2, 4]) | |
| config = FastEsmConfig( | |
| vocab_size=tokenizer.vocab_size, | |
| hidden_size=16 * num_attention_heads, | |
| num_attention_heads=num_attention_heads, | |
| num_hidden_layers=random.choice([1, 2]), | |
| intermediate_size=64 * num_attention_heads, | |
| hidden_dropout_prob=0.0, | |
| attention_probs_dropout_prob=0.0, | |
| mask_token_id=tokenizer.mask_token_id, | |
| pad_token_id=tokenizer.pad_token_id, | |
| max_position_embeddings=256, | |
| emb_layer_norm_before=False, | |
| position_embedding_type="rotary", | |
| attn_backend="sdpa", | |
| ) | |
| batch = tokenizer(["ACDEFG", "MKTW"], return_tensors="pt", padding="longest") | |
| batch["labels"] = batch["input_ids"].clone() | |
| model = FastEsmForMaskedLM(config=config).eval() | |
| with torch.no_grad(): | |
| output = model(**batch, return_dict=True) | |
| print("Batch shape:") | |
| print_tensor_shapes("", batch) | |
| print("Output shape:") | |
| print_tensor_shapes("", output) | |