Upload folder using huggingface_hub

README.md

@@ -0,0 +1,251 @@
+---
+language: rna
+tags:
+  - Biology
+  - RNA
+license: agpl-3.0
+datasets:
+  - multimolecule/rnacentral
+  - multimolecule/rfam
+  - multimolecule/ensembl-genome-browser
+  - multimolecule/nucleotide
+library_name: multimolecule
+pipeline_tag: fill-mask
+mask_token: "<mask>"
+widget:
+  - example_title: "microRNA-21"
+    text: "UAGC<mask>UAUCAGACUGAUGUUGA"
+    output:
+      - label: "A"
+        score: 0.2931748032569885
+      - label: "U"
+        score: 0.2710167169570923
+      - label: "X"
+        score: 0.18341825902462006
+      - label: "C"
+        score: 0.16714636981487274
+      - label: "G"
+        score: 0.08522326499223709
+---
+
+# RiNALMo
+
+Pre-trained model on non-coding RNA (ncRNA) using a masked language modeling (MLM) objective.
+
+## Disclaimer
+
+This is an UNOFFICIAL implementation of the [RiNALMo: General-Purpose RNA Language Models Can Generalize Well on Structure Prediction Tasks](https://doi.org/10.48550/arXiv.2403.00043) by Rafael Josip Penić, et al.
+
+The OFFICIAL repository of RiNALMo is at [lbcb-sci/RiNALMo](https://github.com/lbcb-sci/RiNALMo).
+
+> [!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 RiNALMo did not write this model card for this model so this model card has been written by the MultiMolecule team.**
+
+## Model Details
+
+RiNALMo is a [bert](https://huggingface.co/google-bert/bert-base-uncased)-style model pre-trained on a large corpus of non-coding RNA sequences in a self-supervised fashion. This means that the model was trained on the raw nucleotides of RNA sequences only, with an automatic process to generate inputs and labels from those texts. 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 |
+| ---------- | ----------- | --------- | ----------------- | ------------------ | --------- | -------- | -------------- |
+| 33         | 1280        | 20        | 5120              | 650.88             | 168.92    | 84.43    | 1022           |
+
+### Links
+
+- **Code**: [multimolecule.rinalmo](https://github.com/DLS5-Omics/multimolecule/tree/master/multimolecule/models/rinalmo)
+- **Weights**: [`multimolecule/rinalmo`](https://huggingface.co/multimolecule/rinalmo)
+- **Data**: [RNAcentral](https://rnacentral.org)
+- **Paper**: [RiNALMo: General-Purpose RNA Language Models Can Generalize Well on Structure Prediction Tasks](https://doi.org/10.48550/arXiv.2403.00043)
+- **Developed by**: Rafael Josip Penić, Tin Vlašić, Roland G. Huber, Yue Wan, Mile Šikić
+- **Model type**: [BERT](https://huggingface.co/google-bert/bert-base-uncased)
+- **Original Repository**: [https://github.com/lbcb-sci/RiNALMo](https://github.com/lbcb-sci/RiNALMo)
+
+## 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
+
+You can use this model directly with a pipeline for masked language modeling:
+
+```python
+>>> import multimolecule  # you must import multimolecule to register models
+>>> from transformers import pipeline
+>>> unmasker = pipeline('fill-mask', model='multimolecule/rinalmo')
+>>> unmasker("uagc<mask>uaucagacugauguuga")
+
+[{'score': 0.2931748032569885,
+  'token': 6,
+  'token_str': 'A',
+  'sequence': 'U A G C A U A U C A G A C U G A U G U U G A'},
+ {'score': 0.2710167169570923,
+  'token': 9,
+  'token_str': 'U',
+  'sequence': 'U A G C U U A U C A G A C U G A U G U U G A'},
+ {'score': 0.18341825902462006,
+  'token': 22,
+  'token_str': 'X',
+  'sequence': 'U A G C X U A U C A G A C U G A U G U U G A'},
+ {'score': 0.16714636981487274,
+  'token': 7,
+  'token_str': 'C',
+  'sequence': 'U A G C C U A U C A G A C U G A U G U U G A'},
+ {'score': 0.08522326499223709,
+  'token': 8,
+  'token_str': 'G',
+  'sequence': 'U A G C G U A U C A G A C U G A U G U U G A'}]
+```
+
+### 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, RiNALMoModel
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rinalmo')
+model = RiNALMoModel.from_pretrained('multimolecule/rinalmo')
+
+text = "UAGCUUAUCAGACUGAUGUUGA"
+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, RiNALMoForSequencePrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rinalmo')
+model = RiNALMoForSequencePrediction.from_pretrained('multimolecule/rinalmo')
+
+text = "UAGCUUAUCAGACUGAUGUUGA"
+input = tokenizer(text, return_tensors='pt')
+label = torch.tensor([1])
+
+output = model(**input, labels=label)
+```
+
+#### Nucleotide 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 nucleotide 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, RiNALMoForNucleotidePrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rinalmo')
+model = RiNALMoForNucleotidePrediction.from_pretrained('multimolecule/rinalmo')
+
+text = "UAGCUUAUCAGACUGAUGUUGA"
+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, RiNALMoForContactPrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rinalmo')
+model = RiNALMoForContactPrediction.from_pretrained('multimolecule/rinalmo')
+
+text = "UAGCUUAUCAGACUGAUGUUGA"
+input = tokenizer(text, return_tensors='pt')
+label = torch.randint(2, (len(text), len(text)))
+
+output = model(**input, labels=label)
+```
+
+## Training Details
+
+RiNALMo used Masked Language Modeling (MLM) as the pre-training objective: taking a sequence, the model randomly masks 15% of the tokens in the input then runs the entire masked sentence through the model and has to predict the masked tokens. This is comparable to the Cloze task in language modeling.
+
+### Training Data
+
+The RiNALMo model was pre-trained on a cocktail of databases including [RNAcentral](https://rnacentral.org), [Rfam](https://rfam.org), [Ensembl Genome Browser](https://ensembl.org), and [Nucleotide](https://ncbi.nlm.nih.gov/nucleotide).
+The training data contains 36 million unique ncRNA sequences.
+
+To ensure sequence diversity in each training batch, RiNALMo clustered the sequences with [MMSeqs2](https://github.com/soedinglab/MMseqs2) into 17 million clusters and then sampled each sequence in the batch from a different cluster.
+
+RiNALMo preprocessed all tokens by replacing "U"s with "T"s.
+
+Note that during model conversions, "T" is replaced with "U". [`RnaTokenizer`][multimolecule.RnaTokenizer] will convert "T"s to "U"s for you, you may disable this behaviour by passing `replace_T_with_U=False`.
+
+### Training Procedure
+
+#### Preprocessing
+
+RiNALMo used masked language modeling (MLM) as the pre-training objective. The masking procedure is similar to the one used in BERT:
+
+- 15% of the tokens are masked.
+- In 80% of the cases, the masked tokens are replaced by `<mask>`.
+- In 10% of the cases, the masked tokens are replaced by a random token (different) from the one they replace.
+- In the 10% remaining cases, the masked tokens are left as is.
+
+#### PreTraining
+
+The model was trained on 7 NVIDIA A100 GPUs with 80GiB memories.
+
+- Learning rate: 5e-5
+- Learning rate scheduler: cosine
+- Learning rate warm-up: 2,000 steps
+- Learning rate minimum: 1e-5
+- Epochs: 6
+- Batch Size: 1344
+- Dropout: 0.1
+
+## Citation
+
+**BibTeX**:
+
+```bibtex
+@article{penic2024rinalmo,
+  title={RiNALMo: General-Purpose RNA Language Models Can Generalize Well on Structure Prediction Tasks},
+  author={Penić, Rafael Josip and Vlašić, Tin and Huber, Roland G. and Wan, Yue and Šikić, Mile},
+  journal={arXiv preprint arXiv:2403.00043},
+  year={2024}
+}
+```
+
+## 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 [RiNALMo paper](https://doi.org/10.48550/arXiv.2403.00043) 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,52 @@
+{
+  "architectures": [
+    "RiNALMoForPreTraining"
+  ],
+  "attention_dropout": 0.1,
+  "bos_token_id": 1,
+  "emb_layer_norm_before": true,
+  "eos_token_id": 2,
+  "head": {
+    "act": null,
+    "bias": true,
+    "dropout": 0.0,
+    "hidden_size": null,
+    "layer_norm_eps": 1e-12,
+    "num_labels": null,
+    "output_name": null,
+    "problem_type": null,
+    "transform": null,
+    "transform_act": "gelu"
+  },
+  "hidden_act": "gelu",
+  "hidden_dropout": 0.1,
+  "hidden_size": 1280,
+  "initializer_range": 0.02,
+  "intermediate_size": 5120,
+  "layer_norm_eps": 1e-12,
+  "learnable_beta": true,
+  "lm_head": {
+    "act": null,
+    "bias": true,
+    "dropout": 0.0,
+    "hidden_size": 1280,
+    "layer_norm_eps": 1e-12,
+    "output_name": null,
+    "transform": "nonlinear",
+    "transform_act": "gelu"
+  },
+  "mask_token_id": 4,
+  "max_position_embeddings": 1024,
+  "model_type": "rinalmo",
+  "null_token_id": 5,
+  "num_attention_heads": 20,
+  "num_hidden_layers": 33,
+  "pad_token_id": 0,
+  "position_embedding_type": "rotary",
+  "token_dropout": true,
+  "torch_dtype": "float32",
+  "transformers_version": "4.44.0",
+  "unk_token_id": 3,
+  "use_cache": true,
+  "vocab_size": 26
+}

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2ee31d5955411ad1a763d22d766d01c94091af7b3c92f8e57dd349c88e9225bd
+size 2603718476

pytorch_model.bin

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

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,68 @@
+{
+  "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>",
+  "mask_token": "<mask>",
+  "model_max_length": 1024,
+  "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