# Copyright 2021 AlQuraishi Laboratory # Copyright 2021 DeepMind Technologies Limited # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from functools import partial import weakref import torch import torch.nn as nn from onescience.datapipes.openfold import data_transforms_multimer from onescience.utils.openfold.feats import ( pseudo_beta_fn, build_extra_msa_feat, dgram_from_positions, atom14_to_atom37, ) from onescience.utils.openfold.tensor_utils import masked_mean from openfold.embedders import ( InputEmbedder, InputEmbedderMultimer, RecyclingEmbedder, TemplateEmbedder, TemplateEmbedderMultimer, ExtraMSAEmbedder, PreembeddingEmbedder, ) from openfold.evoformer import EvoformerStack, ExtraMSAStack from openfold.heads import AuxiliaryHeads from openfold.structure_module import StructureModule from openfold.template import ( TemplatePairStack, TemplatePointwiseAttention, embed_templates_average, embed_templates_offload, ) import onescience.utils.openfold.np.residue_constants as residue_constants from onescience.utils.openfold.feats import ( pseudo_beta_fn, build_extra_msa_feat, build_template_angle_feat, build_template_pair_feat, atom14_to_atom37, ) from onescience.utils.openfold.loss import ( compute_plddt, ) from onescience.utils.openfold.tensor_utils import ( add, dict_multimap, tensor_tree_map, ) class AlphaFold(nn.Module): """ Alphafold 2. Implements Algorithm 2 (but with training). """ def __init__(self, config): """ Args: config: A dict-like config object (like the one in config.py) """ super(AlphaFold, self).__init__() self.globals = config.globals self.config = config.model self.template_config = self.config.template self.extra_msa_config = self.config.extra_msa self.seqemb_mode = config.globals.seqemb_mode_enabled # Main trunk + structure module if self.globals.is_multimer: self.input_embedder = InputEmbedderMultimer( **self.config["input_embedder"] ) elif self.seqemb_mode: # If using seqemb mode, embed the sequence embeddings passed # to the model ("preembeddings") instead of embedding the sequence self.input_embedder = PreembeddingEmbedder( **self.config["preembedding_embedder"], ) else: self.input_embedder = InputEmbedder( **self.config["input_embedder"], ) self.recycling_embedder = RecyclingEmbedder( **self.config["recycling_embedder"], ) if self.template_config.enabled: if self.globals.is_multimer: self.template_embedder = TemplateEmbedderMultimer( self.template_config, ) else: self.template_embedder = TemplateEmbedder( self.template_config, ) if self.extra_msa_config.enabled: self.extra_msa_embedder = ExtraMSAEmbedder( **self.extra_msa_config["extra_msa_embedder"], ) self.extra_msa_stack = ExtraMSAStack( **self.extra_msa_config["extra_msa_stack"], ) self.evoformer = EvoformerStack( **self.config["evoformer_stack"], ) self.structure_module = StructureModule( is_multimer=self.globals.is_multimer, **self.config["structure_module"], ) self.aux_heads = AuxiliaryHeads( self.config["heads"], ) def embed_templates(self, batch, feats, z, pair_mask, templ_dim, inplace_safe): if self.globals.is_multimer: asym_id = feats["asym_id"] multichain_mask_2d = ( asym_id[..., None] == asym_id[..., None, :] ) template_embeds = self.template_embedder( batch, z, pair_mask.to(dtype=z.dtype), templ_dim, chunk_size=self.globals.chunk_size, multichain_mask_2d=multichain_mask_2d, use_deepspeed_evo_attention=self.globals.use_deepspeed_evo_attention, use_lma=self.globals.use_lma, inplace_safe=inplace_safe, _mask_trans=self.config._mask_trans ) feats["template_torsion_angles_mask"] = ( template_embeds["template_mask"] ) else: if self.template_config.offload_templates: return embed_templates_offload(self, batch, z, pair_mask, templ_dim, inplace_safe=inplace_safe, ) elif self.template_config.average_templates: return embed_templates_average(self, batch, z, pair_mask, templ_dim, inplace_safe=inplace_safe, ) template_embeds = self.template_embedder( batch, z, pair_mask.to(dtype=z.dtype), templ_dim, chunk_size=self.globals.chunk_size, use_deepspeed_evo_attention=self.globals.use_deepspeed_evo_attention, use_lma=self.globals.use_lma, inplace_safe=inplace_safe, _mask_trans=self.config._mask_trans ) return template_embeds def tolerance_reached(self, prev_pos, next_pos, mask, eps=1e-8) -> bool: """ Early stopping criteria based on criteria used in AF2Complex: https://www.nature.com/articles/s41467-022-29394-2 Args: prev_pos: Previous atom positions in atom37/14 representation next_pos: Current atom positions in atom37/14 representation mask: 1-D sequence mask eps: Epsilon used in square root calculation Returns: Whether to stop recycling early based on the desired tolerance. """ def distances(points): """Compute all pairwise distances for a set of points.""" d = points[..., None, :] - points[..., None, :, :] return torch.sqrt(torch.sum(d ** 2, dim=-1)) if self.config.recycle_early_stop_tolerance < 0: return False ca_idx = residue_constants.atom_order['CA'] sq_diff = (distances(prev_pos[..., ca_idx, :]) - distances(next_pos[..., ca_idx, :])) ** 2 mask = mask[..., None] * mask[..., None, :] sq_diff = masked_mean(mask=mask, value=sq_diff, dim=list(range(len(mask.shape)))) diff = torch.sqrt(sq_diff + eps).item() return diff <= self.config.recycle_early_stop_tolerance def iteration(self, feats, prevs, _recycle=True): # Primary output dictionary outputs = {} # This needs to be done manually for DeepSpeed's sake dtype = next(self.parameters()).dtype for k in feats: if feats[k].dtype == torch.float32: feats[k] = feats[k].to(dtype=dtype) # Grab some data about the input batch_dims = feats["target_feat"].shape[:-2] no_batch_dims = len(batch_dims) n = feats["target_feat"].shape[-2] n_seq = feats["msa_feat"].shape[-3] device = feats["target_feat"].device # Controls whether the model uses in-place operations throughout # The dual condition accounts for activation checkpoints inplace_safe = not (self.training or torch.is_grad_enabled()) # Prep some features seq_mask = feats["seq_mask"] pair_mask = seq_mask[..., None] * seq_mask[..., None, :] msa_mask = feats["msa_mask"] if self.globals.is_multimer: # Initialize the MSA and pair representations # m: [*, S_c, N, C_m] # z: [*, N, N, C_z] m, z = self.input_embedder(feats) elif self.seqemb_mode: # Initialize the SingleSeq and pair representations # m: [*, 1, N, C_m] # z: [*, N, N, C_z] m, z = self.input_embedder( feats["target_feat"], feats["residue_index"], feats["seq_embedding"] ) else: # Initialize the MSA and pair representations # m: [*, S_c, N, C_m] # z: [*, N, N, C_z] m, z = self.input_embedder( feats["target_feat"], feats["residue_index"], feats["msa_feat"], inplace_safe=inplace_safe, ) # Unpack the recycling embeddings. Removing them from the list allows # them to be freed further down in this function, saving memory m_1_prev, z_prev, x_prev = reversed([prevs.pop() for _ in range(3)]) # Initialize the recycling embeddings, if needs be if None in [m_1_prev, z_prev, x_prev]: # [*, N, C_m] m_1_prev = m.new_zeros( (*batch_dims, n, self.config.input_embedder.c_m), requires_grad=False, ) # [*, N, N, C_z] z_prev = z.new_zeros( (*batch_dims, n, n, self.config.input_embedder.c_z), requires_grad=False, ) # [*, N, 3] x_prev = z.new_zeros( (*batch_dims, n, residue_constants.atom_type_num, 3), requires_grad=False, ) pseudo_beta_x_prev = pseudo_beta_fn( feats["aatype"], x_prev, None ).to(dtype=z.dtype) # The recycling embedder is memory-intensive, so we offload first if self.globals.offload_inference and inplace_safe: m = m.cpu() z = z.cpu() # m_1_prev_emb: [*, N, C_m] # z_prev_emb: [*, N, N, C_z] m_1_prev_emb, z_prev_emb = self.recycling_embedder( m_1_prev, z_prev, pseudo_beta_x_prev, inplace_safe=inplace_safe, ) del pseudo_beta_x_prev if self.globals.offload_inference and inplace_safe: m = m.to(m_1_prev_emb.device) z = z.to(z_prev.device) # [*, S_c, N, C_m] m[..., 0, :, :] += m_1_prev_emb # [*, N, N, C_z] z = add(z, z_prev_emb, inplace=inplace_safe) # Deletions like these become significant for inference with large N, # where they free unused tensors and remove references to others such # that they can be offloaded later del m_1_prev, z_prev, m_1_prev_emb, z_prev_emb # Embed the templates + merge with MSA/pair embeddings if self.config.template.enabled: template_feats = { k: v for k, v in feats.items() if k.startswith("template_") } template_embeds = self.embed_templates( template_feats, feats, z, pair_mask.to(dtype=z.dtype), no_batch_dims, inplace_safe=inplace_safe, ) # [*, N, N, C_z] z = add(z, template_embeds.pop("template_pair_embedding"), inplace_safe, ) if ( "template_single_embedding" in template_embeds ): # [*, S = S_c + S_t, N, C_m] m = torch.cat( [m, template_embeds["template_single_embedding"]], dim=-3 ) # [*, S, N] if not self.globals.is_multimer: torsion_angles_mask = feats["template_torsion_angles_mask"] msa_mask = torch.cat( [feats["msa_mask"], torsion_angles_mask[..., 2]], dim=-2 ) else: msa_mask = torch.cat( [feats["msa_mask"], template_embeds["template_mask"]], dim=-2, ) # Embed extra MSA features + merge with pairwise embeddings if self.config.extra_msa.enabled: if self.globals.is_multimer: extra_msa_fn = data_transforms_multimer.build_extra_msa_feat else: extra_msa_fn = build_extra_msa_feat # [*, S_e, N, C_e] extra_msa_feat = extra_msa_fn(feats).to(dtype=z.dtype) a = self.extra_msa_embedder(extra_msa_feat) if self.globals.offload_inference: # To allow the extra MSA stack (and later the evoformer) to # offload its inputs, we remove all references to them here input_tensors = [a, z] del a, z # [*, N, N, C_z] z = self.extra_msa_stack._forward_offload( input_tensors, msa_mask=feats["extra_msa_mask"].to(dtype=m.dtype), chunk_size=self.globals.chunk_size, use_deepspeed_evo_attention=self.globals.use_deepspeed_evo_attention, use_lma=self.globals.use_lma, pair_mask=pair_mask.to(dtype=m.dtype), _mask_trans=self.config._mask_trans, ) del input_tensors else: # [*, N, N, C_z] z = self.extra_msa_stack( a, z, msa_mask=feats["extra_msa_mask"].to(dtype=m.dtype), chunk_size=self.globals.chunk_size, use_deepspeed_evo_attention=self.globals.use_deepspeed_evo_attention, use_lma=self.globals.use_lma, pair_mask=pair_mask.to(dtype=m.dtype), inplace_safe=inplace_safe, _mask_trans=self.config._mask_trans, ) # Run MSA + pair embeddings through the trunk of the network # m: [*, S, N, C_m] # z: [*, N, N, C_z] # s: [*, N, C_s] if self.globals.offload_inference: input_tensors = [m, z] del m, z m, z, s = self.evoformer._forward_offload( input_tensors, msa_mask=msa_mask.to(dtype=input_tensors[0].dtype), pair_mask=pair_mask.to(dtype=input_tensors[1].dtype), chunk_size=self.globals.chunk_size, use_deepspeed_evo_attention=self.globals.use_deepspeed_evo_attention, use_lma=self.globals.use_lma, _mask_trans=self.config._mask_trans, ) del input_tensors else: m, z, s = self.evoformer( m, z, msa_mask=msa_mask.to(dtype=m.dtype), pair_mask=pair_mask.to(dtype=z.dtype), chunk_size=self.globals.chunk_size, use_deepspeed_evo_attention=self.globals.use_deepspeed_evo_attention, use_lma=self.globals.use_lma, use_flash=self.globals.use_flash, inplace_safe=inplace_safe, _mask_trans=self.config._mask_trans, ) outputs["msa"] = m[..., :n_seq, :, :] outputs["pair"] = z outputs["single"] = s del z # Predict 3D structure outputs["sm"] = self.structure_module( outputs, feats["aatype"], mask=feats["seq_mask"].to(dtype=s.dtype), inplace_safe=inplace_safe, _offload_inference=self.globals.offload_inference, ) outputs["final_atom_positions"] = atom14_to_atom37( outputs["sm"]["positions"][-1], feats ) outputs["final_atom_mask"] = feats["atom37_atom_exists"] outputs["final_affine_tensor"] = outputs["sm"]["frames"][-1] # Save embeddings for use during the next recycling iteration # [*, N, C_m] m_1_prev = m[..., 0, :, :] # [*, N, N, C_z] z_prev = outputs["pair"] early_stop = False if self.globals.is_multimer: early_stop = self.tolerance_reached(x_prev, outputs["final_atom_positions"], seq_mask) del x_prev # [*, N, 3] x_prev = outputs["final_atom_positions"] return outputs, m_1_prev, z_prev, x_prev, early_stop def _disable_activation_checkpointing(self): self.template_embedder.template_pair_stack.blocks_per_ckpt = None self.evoformer.blocks_per_ckpt = None for b in self.extra_msa_stack.blocks: b.ckpt = False def _enable_activation_checkpointing(self): self.template_embedder.template_pair_stack.blocks_per_ckpt = ( self.config.template.template_pair_stack.blocks_per_ckpt ) self.evoformer.blocks_per_ckpt = ( self.config.evoformer_stack.blocks_per_ckpt ) for b in self.extra_msa_stack.blocks: b.ckpt = self.config.extra_msa.extra_msa_stack.ckpt def forward(self, batch): """ Args: batch: Dictionary of arguments outlined in Algorithm 2. Keys must include the official names of the features in the supplement subsection 1.2.9. The final dimension of each input must have length equal to the number of recycling iterations. Features (without the recycling dimension): "aatype" ([*, N_res]): Contrary to the supplement, this tensor of residue indices is not one-hot. "target_feat" ([*, N_res, C_tf]) One-hot encoding of the target sequence. C_tf is config.model.input_embedder.tf_dim. "residue_index" ([*, N_res]) Tensor whose final dimension consists of consecutive indices from 0 to N_res. "msa_feat" ([*, N_seq, N_res, C_msa]) MSA features, constructed as in the supplement. C_msa is config.model.input_embedder.msa_dim. "seq_mask" ([*, N_res]) 1-D sequence mask "msa_mask" ([*, N_seq, N_res]) MSA mask "pair_mask" ([*, N_res, N_res]) 2-D pair mask "extra_msa_mask" ([*, N_extra, N_res]) Extra MSA mask "template_mask" ([*, N_templ]) Template mask (on the level of templates, not residues) "template_aatype" ([*, N_templ, N_res]) Tensor of template residue indices (indices greater than 19 are clamped to 20 (Unknown)) "template_all_atom_positions" ([*, N_templ, N_res, 37, 3]) Template atom coordinates in atom37 format "template_all_atom_mask" ([*, N_templ, N_res, 37]) Template atom coordinate mask "template_pseudo_beta" ([*, N_templ, N_res, 3]) Positions of template carbon "pseudo-beta" atoms (i.e. C_beta for all residues but glycine, for for which C_alpha is used instead) "template_pseudo_beta_mask" ([*, N_templ, N_res]) Pseudo-beta mask """ # Initialize recycling embeddings m_1_prev, z_prev, x_prev = None, None, None prevs = [m_1_prev, z_prev, x_prev] is_grad_enabled = torch.is_grad_enabled() # Main recycling loop num_iters = batch["aatype"].shape[-1] early_stop = False num_recycles = 0 for cycle_no in range(num_iters): # Select the features for the current recycling cycle fetch_cur_batch = lambda t: t[..., cycle_no] feats = tensor_tree_map(fetch_cur_batch, batch) # Enable grad iff we're training and it's the final recycling layer is_final_iter = cycle_no == (num_iters - 1) or early_stop with torch.set_grad_enabled(is_grad_enabled and is_final_iter): if is_final_iter: # Sidestep AMP bug (PyTorch issue #65766) if torch.is_autocast_enabled(): torch.clear_autocast_cache() # Run the next iteration of the model outputs, m_1_prev, z_prev, x_prev, early_stop = self.iteration( feats, prevs, _recycle=(num_iters > 1) ) num_recycles += 1 if not is_final_iter: del outputs prevs = [m_1_prev, z_prev, x_prev] del m_1_prev, z_prev, x_prev else: break outputs["num_recycles"] = torch.tensor(num_recycles, device=feats["aatype"].device) if "asym_id" in batch: outputs["asym_id"] = feats["asym_id"] # Run auxiliary heads outputs.update(self.aux_heads(outputs)) return outputs