Upload folder using huggingface_hub

README.md

@@ -0,0 +1,276 @@
+---
+language: rna
+tags:
+  - Biology
+  - RNA
+license: agpl-3.0
+datasets:
+  - multimolecule/ribonanza
+library_name: multimolecule
+base_model: multimolecule/ribonanzanet
+---
+
+# RibonanzaNet
+
+> [!IMPORTANT]
+> This model is in a future release of MultiMolecule, and is under development.
+> This model card is not final and will be updated in the future.
+
+Pre-trained model on RNA chemical mapping for modeling RNA structure and other properties.
+
+## Disclaimer
+
+This is an UNOFFICIAL implementation of the [Ribonanza: deep learning of RNA structure through dual crowdsourcing](https://doi.org/10.1101/2024.02.24.581671) by Shujun He, Rui Huang, et al.
+
+The OFFICIAL repository of RibonanzaNet is at [Shujun-He/RibonanzaNet](https://github.com/Shujun-He/RibonanzaNet).
+
+> [!WARNING]
+> The MultiMolecule team is aware of a potential risk in reproducing the results of RibonanzaNet.
+>
+> The original implementation of RibonanzaNet does not prepend `<cls>` and append `<eos>` tokens to the input sequence.
+> This should not affect the performance of the model in most cases, but it can lead to unexpected behavior in some cases.
+>
+> Please set `cls_token=None` and `eos_token=None` explicitly in the tokenizer and model configuration if you want the exact behavior of the original implementation.
+
+> [!WARNING]
+> The MultiMolecule team is aware of a potential risk in reproducing the results of RibonanzaNet.
+>
+> The original implementation of RibonanzaNet applied `dropout-residual-norm` path twice to the output of the Self-Attention layer.
+>
+> By default, the MultiMolecule follows the original implementation.
+>
+> You can set `fix_attention_norm=True` in the model configuration to apply the `dropout-residual-norm` path once.
+>
+> See more at [issue #3](https://github.com/Shujun-He/RibonanzaNet/issues/3)
+
+> [!WARNING]
+> The MultiMolecule team is aware of a potential risk in reproducing the results of RibonanzaNet.
+>
+> The original implementation of RibonanzaNet does not apply attention mask correctly.
+>
+> By default, the MultiMolecule follows the original implementation.
+>
+> You can set `fix_attention_mask=True` in the model configuration to apply the correct attention mask.
+>
+> See more at [issue #4](https://github.com/Shujun-He/RibonanzaNet/issues/4), [issue #5](https://github.com/Shujun-He/RibonanzaNet/issues/5), and [issue #7](https://github.com/Shujun-He/RibonanzaNet/issues/7)
+
+> [!WARNING]
+> The MultiMolecule team is aware of a potential risk in reproducing the results of RibonanzaNet.
+>
+> The original implementation of RibonanzaNet applies dropout in an axis different from the one described in the paper.
+>
+> By default, the MultiMolecule follows the original implementation.
+>
+> You can set `fix_pairwise_dropout=True` in the model configuration to follow the description in the paper.
+>
+> See more at [issue #6](https://github.com/Shujun-He/RibonanzaNet/issues/6)
+
+> [!TIP]
+> The MultiMolecule team has confirmed that the provided model and checkpoints are producing the same intermediate representations as the original implementation.
+
+**The team releasing RibonanzaNet did not write this model card for this model so this model card has been written by the MultiMolecule team.**
+
+## Model Details
+
+RibonanzaNet is a [bert](https://huggingface.co/google-bert/bert-base-uncased)-style model.
+RibonanzaNet follows the modification from the [RNAdegformer](https://academic.oup.com/bib/article/24/1/bbac581/6986359) where it introduces a 1D convolution with residual connection at the beginning of each encoder layer.
+Different from RNAdegformer, RibonanzaNet does not apply deconvolution at the end of the encoder layers, and updates the pairwise representation through outer product mean and triangular update.
+
+RibonanzaNet is pre-trained on a large corpus of RNA sequences with chemical mapping (2A3 and DMS) measurements.
+Please refer to the [Training Details](#training-details) section for more information on the training process.
+
+### Model Specification
+
+| Num Layers | Hidden Size | Num Heads | Intermediate Size | Num Parameters (M) | FLOPs (G) | MACs (G) | Max Num Tokens |
+| ---------- | ----------- | --------- | ----------------- | ------------------ | --------- | -------- | -------------- |
+| 9          | 256         | 8         | 1024              | 11.37              | 53.65     | 26.66    | inf            |
+
+### Links
+
+- **Code**: [multimolecule.ribonanzanet](https://github.com/DLS5-Omics/multimolecule/tree/master/multimolecule/models/ribonanzanet)
+- **Weights**: [multimolecule/ribonanzanet](https://huggingface.co/multimolecule/ribonanzanet)
+- **Data**: [multimolecule/ribonanza](https://multimolecule.danling.org/datasets/ribonanza)
+- **Paper**: [Ribonanza: deep learning of RNA structure through dual crowdsourcing](https://doi.org/10.1101/2024.02.24.581671)
+- **Developed by**: Shujun He, Rui Huang, Jill Townley, Rachael C. Kretsch, Thomas G. Karagianes, David B.T. Cox, Hamish Blair, Dmitry Penzar, Valeriy Vyaltsev, Elizaveta Aristova, Arsenii Zinkevich, Artemy Bakulin, Hoyeol Sohn, Daniel Krstevski, Takaaki Fukui, Fumiya Tatematsu, Yusuke Uchida, Donghoon Jang, Jun Seong Lee, Roger Shieh, Tom Ma, Eduard Martynov, Maxim V. Shugaev, Habib S.T. Bukhari, Kazuki Fujikawa, Kazuki Onodera, Christof Henkel, Shlomo Ron, Jonathan Romano, John J. Nicol, Grace P. Nye, Yuan Wu, Christian Choe, Walter Reade, Eterna participants, Rhiju Das
+- **Model type**: [BERT](https://huggingface.co/google-bert/bert-base-uncased)
+- **Original Repository**: [Shujun-He/RibonanzaNet](https://github.com/Shujun-He/RibonanzaNet)
+
+## Usage
+
+The model file depends on the [`multimolecule`](https://multimolecule.danling.org) library. You can install it using pip:
+
+```bash
+pip install multimolecule
+```
+
+### Direct Use
+
+This model is fine-tuned on the number of 2A3 and DMS Illumina sequencer read counts from Ribonanza.
+
+You can use this model directly to predict the experimental dropout of an RNA sequence:
+
+```python
+>>> from multimolecule import RnaTokenizer, RibonanzaNetForDegradationPrediction
+
+>>> tokenizer = RnaTokenizer.from_pretrained("multimolecule/ribonanzanet")
+>>> model = RibonanzaNetForDegradationPrediction.from_pretrained("multimolecule/ribonanzanet")
+>>> output = model(**tokenizer("agcagucauuauggcgaa", return_tensors="pt"))
+
+>>> output.logits_2a3.squeeze()
+tensor([5.8581, 4.6132, 3.3275, 3.5843, 4.2395, 6.0112, 3.0144, 4.9608, 7.2260,
+        7.8455, 6.9927, 7.2180, 4.3897, 3.4101, 2.6565, 5.2316, 4.9018, 3.0297],
+       grad_fn=<SqueezeBackward0>)
+
+>>> output.logits_dms.squeeze()
+tensor([8.8506, 3.6883, 6.5249, 6.5681, 3.9503, 4.6431, 5.1649, 7.2691, 4.2269,
+        4.8830, 7.0784, 5.6316, 4.5210, 4.4669, 5.3768, 4.2098, 6.8370, 6.4024],
+       grad_fn=<SqueezeBackward0>)
+```
+
+### Downstream Use
+
+#### Extract Features
+
+Here is how to use this model to get the features of a given sequence in PyTorch:
+
+```python
+from multimolecule import RnaTokenizer, RibonanzaNetModel
+
+
+tokenizer = RnaTokenizer.from_pretrained("multimolecule/ribonanzanet")
+model = RibonanzaNetModel.from_pretrained("multimolecule/ribonanzanet")
+
+text = "UAGCUUAUCAGACUGAUGUUG"
+input = tokenizer(text, return_tensors="pt")
+
+output = model(**input)
+```
+
+#### Sequence Classification / Regression
+
+> [!NOTE]
+> This model is not fine-tuned for any specific task. You will need to fine-tune the model on a downstream task to use it for sequence classification or regression.
+
+Here is how to use this model as backbone to fine-tune for a sequence-level task in PyTorch:
+
+```python
+import torch
+from multimolecule import RnaTokenizer, RibonanzaNetForSequencePrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained("multimolecule/ribonanzanet")
+model = RibonanzaNetForSequencePrediction.from_pretrained("multimolecule/ribonanzanet")
+
+text = "UAGCUUAUCAGACUGAUGUUG"
+input = tokenizer(text, return_tensors="pt")
+label = torch.tensor([1])
+
+output = model(**input, labels=label)
+```
+
+#### Token Classification / Regression
+
+> [!NOTE]
+> This model is not fine-tuned for any specific task. You will need to fine-tune the model on a downstream task to use it for token classification or regression.
+
+Here is how to use this model as backbone to fine-tune for a nucleotide-level task in PyTorch:
+
+```python
+import torch
+from multimolecule import RnaTokenizer, RibonanzaNetForTokenPrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained("multimolecule/ribonanzanet")
+model = RibonanzaNetForTokenPrediction.from_pretrained("multimolecule/ribonanzanet")
+
+text = "UAGCUUAUCAGACUGAUGUUG"
+input = tokenizer(text, return_tensors="pt")
+label = torch.randint(2, (len(text), ))
+
+output = model(**input, labels=label)
+```
+
+#### Contact Classification / Regression
+
+> [!NOTE]
+> This model is not fine-tuned for any specific task. You will need to fine-tune the model on a downstream task to use it for contact classification or regression.
+
+Here is how to use this model as backbone to fine-tune for a contact-level task in PyTorch:
+
+```python
+import torch
+from multimolecule import RnaTokenizer, RibonanzaNetForContactPrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained("multimolecule/ribonanzanet")
+model = RibonanzaNetForContactPrediction.from_pretrained("multimolecule/ribonanzanet")
+
+text = "UAGCUUAUCAGACUGAUGUUG"
+input = tokenizer(text, return_tensors="pt")
+label = torch.randint(2, (len(text), len(text)))
+
+output = model(**input, labels=label)
+```
+
+## Training Details
+
+RibonanzaNet used chemical mapping data as the training objective. The model takes an RNA sequence as input and predicts the chemical reactivity of each nucleotide.
+
+### Training Data
+
+The RibonanzaNet model was trained on the Ribonanza dataset. Ribonanza is a dataset of chemical mapping measurements on two million diverse RNA sequences. The data was collected from the crowdsourced initiative Eterna, as well as expert databases such as [Rfam](https://huggingface.co/datasets/multimolecule/rfam), the PDB archive, Pseudobase, and the RNA Mapping Database.
+
+### Training Procedure
+
+RibonanzaNet was trained using a three-stage process:
+
+#### Initial Training
+
+The initial model was trained using sequences that had either or both 2A3/DMS profiles with a signal-to-noise ratio (SNR) above 1.0. This dataset comprised 214,831 training sequences.
+
+#### Pre-training
+
+1. Noisy Training Data: The model was first pre-trained on the data with a signal-to-noise ratio (SNR) below 1.0 using predictions from top 3 Kaggle models as pseudo-labels. This dataset comprised 563,796 sequences.
+2. Experimental Determined Data: The model was then further trained for 10 epochs using only the true labels of sequences with high SNR (either 2A3 or DMS profiles).
+
+#### Final Training
+
+1. Noisy Training Data: The model was first pre-trained on all training and testing data using predictions from top 3 Kaggle models as pseudo-labels. This dataset comprised 1,907,619 sequences.
+2. Experimental Determined Data: The model was then further annelaed on the true training labels.
+
+The model was trained on 10 NVIDIA L40S GPUs with 48GiB memories.
+
+Sequence flip augmentation was applied to the training data.
+
+## Citation
+
+**BibTeX**:
+
+```bibtex
+@article{He2024.02.24.581671,
+  author       = {He, Shujun and Huang, Rui and Townley, Jill and Kretsch, Rachael C. and Karagianes, Thomas G. and Cox, David B.T. and Blair, Hamish and Penzar, Dmitry and Vyaltsev, Valeriy and Aristova, Elizaveta and Zinkevich, Arsenii and Bakulin, Artemy and Sohn, Hoyeol and Krstevski, Daniel and Fukui, Takaaki and Tatematsu, Fumiya and Uchida, Yusuke and Jang, Donghoon and Lee, Jun Seong and Shieh, Roger and Ma, Tom and Martynov, Eduard and Shugaev, Maxim V. and Bukhari, Habib S.T. and Fujikawa, Kazuki and Onodera, Kazuki and Henkel, Christof and Ron, Shlomo and Romano, Jonathan and Nicol, John J. and Nye, Grace P. and Wu, Yuan and Choe, Christian and Reade, Walter and Eterna participants and Das, Rhiju},
+  title        = {Ribonanza: deep learning of RNA structure through dual crowdsourcing},
+  elocation-id = {2024.02.24.581671},
+  year         = {2024},
+  doi          = {10.1101/2024.02.24.581671},
+  publisher    = {Cold Spring Harbor Laboratory},
+  abstract     = {Prediction of RNA structure from sequence remains an unsolved problem, and progress has been slowed by a paucity of experimental data. Here, we present Ribonanza, a dataset of chemical mapping measurements on two million diverse RNA sequences collected through Eterna and other crowdsourced initiatives. Ribonanza measurements enabled solicitation, training, and prospective evaluation of diverse deep neural networks through a Kaggle challenge, followed by distillation into a single, self-contained model called RibonanzaNet. When fine tuned on auxiliary datasets, RibonanzaNet achieves state-of-the-art performance in modeling experimental sequence dropout, RNA hydrolytic degradation, and RNA secondary structure, with implications for modeling RNA tertiary structure.Competing Interest StatementStanford University is filing patent applications based on concepts described in this paper. R.D. is a cofounder of Inceptive.},
+  url          = {https://www.biorxiv.org/content/early/2024/06/11/2024.02.24.581671},
+  eprint       = {https://www.biorxiv.org/content/early/2024/06/11/2024.02.24.581671.full.pdf},
+  journal      = {bioRxiv}
+}
+```
+
+## Contact
+
+Please use GitHub issues of [MultiMolecule](https://github.com/DLS5-Omics/multimolecule/issues) for any questions or comments on the model card.
+
+Please contact the authors of the [RibonanzaNet paper](https://doi.org/10.1101/2024.02.24.581671) for questions or comments on the paper/model.
+
+## License
+
+This model is licensed under the [AGPL-3.0 License](https://www.gnu.org/licenses/agpl-3.0.html).
+
+```spdx
+SPDX-License-Identifier: AGPL-3.0-or-later
+```

config.json

@@ -0,0 +1,41 @@
+{
+  "architectures": [
+    "RibonanzaNetForSequenceDropoutPrediction"
+  ],
+  "attention_dropout": 0.05,
+  "bos_token_id": 1,
+  "eos_token_id": 2,
+  "fix_attention_mask": false,
+  "fix_attention_norm": false,
+  "fix_pairwise_dropout": false,
+  "head": null,
+  "hidden_act": "gelu",
+  "hidden_dropout": 0.05,
+  "hidden_size": 256,
+  "id2label": null,
+  "initializer_range": 0.02,
+  "intermediate_size": 1024,
+  "kernel_size": 5,
+  "label2id": null,
+  "layer_norm_eps": 1e-12,
+  "lm_head": null,
+  "mask_token_id": 4,
+  "model_type": "ribonanzanet",
+  "null_token_id": 5,
+  "num_attention_heads": 8,
+  "num_hidden_layers": 9,
+  "num_labels": 1,
+  "output_pairwise_states": false,
+  "pad_token_id": 0,
+  "pairwise_attention_size": 32,
+  "pairwise_hidden_act": "relu",
+  "pairwise_intermediate_size": 256,
+  "pairwise_num_attention_heads": 4,
+  "pairwise_size": 64,
+  "torch_dtype": "float32",
+  "transformers_version": "4.48.2",
+  "type_vocab_size": 2,
+  "unk_token_id": 3,
+  "use_triangular_attention": false,
+  "vocab_size": 26
+}

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:166264c95e8570e3e40cf33baa67e6972e0c0eb89a641ef7321182c27111f3a6
+size 45285104

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:512db8ba00f771cb4054f4755f6e2cb58c041e2265ec3c5be6764458713fdc3b
+size 45408082

special_tokens_map.json

@@ -0,0 +1,12 @@
+{
+  "additional_special_tokens": [
+    "<null>"
+  ],
+  "bos_token": "<cls>",
+  "cls_token": "<cls>",
+  "eos_token": "<eos>",
+  "mask_token": "<mask>",
+  "pad_token": "<pad>",
+  "sep_token": "<eos>",
+  "unk_token": "<unk>"
+}

tokenizer_config.json

@@ -0,0 +1,69 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "<pad>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "1": {
+      "content": "<cls>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "2": {
+      "content": "<eos>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "3": {
+      "content": "<unk>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "4": {
+      "content": "<mask>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "5": {
+      "content": "<null>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "additional_special_tokens": [
+    "<null>"
+  ],
+  "bos_token": "<cls>",
+  "clean_up_tokenization_spaces": true,
+  "cls_token": "<cls>",
+  "codon": false,
+  "eos_token": "<eos>",
+  "extra_special_tokens": {},
+  "mask_token": "<mask>",
+  "model_max_length": 1000000000000000019884624838656,
+  "nmers": 1,
+  "pad_token": "<pad>",
+  "replace_T_with_U": true,
+  "sep_token": "<eos>",
+  "tokenizer_class": "RnaTokenizer",
+  "unk_token": "<unk>"
+}

vocab.txt

@@ -0,0 +1,26 @@
+<pad>
+<cls>
+<eos>
+<unk>
+<mask>
+<null>
+A
+C
+G
+U
+N
+R
+Y
+S
+W
+K
+M
+B
+D
+H
+V
+.
+X
+*
+-
+I