Upload folder using huggingface_hub

README.md

@@ -0,0 +1,259 @@
+---
+language: rna
+tags:
+  - Biology
+  - RNA
+license: agpl-3.0
+datasets:
+  - multimolecule/rnacentral
+library_name: multimolecule
+pipeline_tag: fill-mask
+mask_token: "<mask>"
+widget:
+  - example_title: "microRNA-21"
+    text: "UAGC<mask>UAUCAGACUGAUGUUGA"
+    output:
+      - label: "N"
+        score: 0.0385337695479393
+      - label: "I"
+        score: 0.03851701319217682
+      - label: "<unk>"
+        score: 0.03850541263818741
+      - label: "<null>"
+        score: 0.03850402310490608
+      - label: "<cls>"
+        score: 0.03848475590348244
+---
+
+# RNABERT
+
+Pre-trained model on non-coding RNA (ncRNA) using masked language modeling (MLM) and structural alignment learning (SAL) objectives.
+
+## Disclaimer
+
+This is an UNOFFICIAL implementation of the [Informative RNA-base embedding for functional RNA clustering and structural alignment](https://doi.org/10.1093/nargab/lqac012) by Manato Akiyama and Yasubumi Sakakibara.
+
+The OFFICIAL repository of RNABERT is at [mana438/RNABERT](https://github.com/mana438/RNABERT).
+
+> [!CAUTION]
+> The MultiMolecule team is aware of a potential risk in reproducing the results of RNABERT.
+>
+> The original implementation of RNABERT 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 if you want the exact behavior of the original implementation.
+
+> [!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 RNABERT did not write this model card for this model so this model card has been written by the MultiMolecule team.**
+
+## Model Details
+
+RNABERT 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 |
+| ---------- | ----------- | --------- | ----------------- | ------------------ | --------- | -------- | -------------- |
+| 6          | 120         | 12        | 40                | 0.48               | 0.15      | 0.08     | 440            |
+
+### Links
+
+- **Code**: [multimolecule.rnabert](https://github.com/DLS5-Omics/multimolecule/tree/master/multimolecule/models/rnabert)
+- **Weights**: [multimolecule/rnabert](https://huggingface.co/multimolecule/rnabert)
+- **Data**: [RNAcentral](https://rnacentral.org)
+- **Paper**: [Informative RNA-base embedding for functional RNA clustering and structural alignment](https://doi.org/10.1093/nargab/lqac012)
+- **Developed by**: JManato Akiyama and Yasubumi Sakakibara
+- **Model type**: [BERT](https://huggingface.co/google-bert/bert-base-uncased)
+- **Original Repository**: [https://github.com/mana438/RNABERT](https://github.com/mana438/RNABERT)
+
+## 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/rnabert')
+>>> unmasker("uagc<mask>uaucagacugauguuga")
+
+[{'score': 0.0385337695479393,
+  'token': 10,
+  'token_str': 'N',
+  'sequence': 'U A G C N U A U C A G A C U G A U G U U G A'},
+ {'score': 0.03851701319217682,
+  'token': 25,
+  'token_str': 'I',
+  'sequence': 'U A G C I U A U C A G A C U G A U G U U G A'},
+ {'score': 0.03850541263818741,
+  'token': 3,
+  'token_str': '<unk>',
+  'sequence': 'U A G C U A U C A G A C U G A U G U U G A'},
+ {'score': 0.03850402310490608,
+  'token': 5,
+  'token_str': '<null>',
+  'sequence': 'U A G C U A U C A G A C U G A U G U U G A'},
+ {'score': 0.03848475590348244,
+  'token': 1,
+  'token_str': '<cls>',
+  'sequence': 'U A G C 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, RnaBertModel
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rnabert')
+model = RnaBertModel.from_pretrained('multimolecule/rnabert')
+
+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, RnaBertForSequencePrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rnabert')
+model = RnaBertForSequencePrediction.from_pretrained('multimolecule/rnabert')
+
+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, RnaBertForNucleotidePrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rnabert')
+model = RnaBertForNucleotidePrediction.from_pretrained('multimolecule/rnabert')
+
+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, RnaBertForContactPrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/rnabert')
+model = RnaBertForContactPrediction.from_pretrained('multimolecule/rnabert')
+
+text = "UAGCUUAUCAGACUGAUGUUGA"
+input = tokenizer(text, return_tensors='pt')
+label = torch.randint(2, (len(text), len(text)))
+
+output = model(**input, labels=label)
+```
+
+## Training Details
+
+RNABERT has two pre-training objectives: masked language modeling (MLM) and structural alignment learning (SAL).
+
+- **Masked Language Modeling (MLM)**: 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.
+- **Structural Alignment Learning (SAL)**: the model learns to predict the structural alignment of two RNA sequences. The model is trained to predict the alignment score of two RNA sequences using the Needleman-Wunsch algorithm.
+
+### Training Data
+
+The RNABERT model was pre-trained on [RNAcentral](https://multimolecule.danling.org/datasets/rnacentral/).
+RNAcentral is a free, public resource that offers integrated access to a comprehensive and up-to-date set of non-coding RNA sequences provided by a collaborating group of [Expert Databases](https://rnacentral.org/expert-databases) representing a broad range of organisms and RNA types.
+
+RNABERT used a subset of 76, 237 human ncRNA sequences from RNAcentral for pre-training.
+RNABERT 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
+
+RNABERT preprocess the dataset by applying 10 different mask patterns to the 72, 237 human ncRNA sequences. The final dataset contains 722, 370 sequences. 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 1 NVIDIA V100 GPU.
+
+## Citation
+
+**BibTeX**:
+
+```bibtex
+@article{akiyama2022informative,
+    author = {Akiyama, Manato and Sakakibara, Yasubumi},
+    title = "{Informative RNA base embedding for RNA structural alignment and clustering by deep representation learning}",
+    journal = {NAR Genomics and Bioinformatics},
+    volume = {4},
+    number = {1},
+    pages = {lqac012},
+    year = {2022},
+    month = {02},
+    abstract = "{Effective embedding is actively conducted by applying deep learning to biomolecular information. Obtaining better embeddings enhances the quality of downstream analyses, such as DNA sequence motif detection and protein function prediction. In this study, we adopt a pre-training algorithm for the effective embedding of RNA bases to acquire semantically rich representations and apply this algorithm to two fundamental RNA sequence problems: structural alignment and clustering. By using the pre-training algorithm to embed the four bases of RNA in a position-dependent manner using a large number of RNA sequences from various RNA families, a context-sensitive embedding representation is obtained. As a result, not only base information but also secondary structure and context information of RNA sequences are embedded for each base. We call this ‘informative base embedding’ and use it to achieve accuracies superior to those of existing state-of-the-art methods on RNA structural alignment and RNA family clustering tasks. Furthermore, upon performing RNA sequence alignment by combining this informative base embedding with a simple Needleman–Wunsch alignment algorithm, we succeed in calculating structural alignments with a time complexity of O(n2) instead of the O(n6) time complexity of the naive implementation of Sankoff-style algorithm for input RNA sequence of length n.}",
+    issn = {2631-9268},
+    doi = {10.1093/nargab/lqac012},
+    url = {https://doi.org/10.1093/nargab/lqac012},
+    eprint = {https://academic.oup.com/nargab/article-pdf/4/1/lqac012/42577168/lqac012.pdf},
+}
+```
+
+## 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 [RNABERT paper](https://doi.org/10.1093/nargab/lqac012) 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,51 @@
+{
+  "architectures": [
+    "RnaBertForPreTraining"
+  ],
+  "attention_dropout": 0.0,
+  "bos_token_id": 1,
+  "eos_token_id": 2,
+  "head": {
+    "act": null,
+    "bias": true,
+    "dropout": 0.0,
+    "hidden_size": 120,
+    "layer_norm_eps": 1e-12,
+    "num_labels": 2,
+    "output_name": null,
+    "problem_type": null,
+    "transform": null,
+    "transform_act": "gelu"
+  },
+  "hidden_act": "gelu",
+  "hidden_dropout": 0.0,
+  "hidden_size": 120,
+  "initializer_range": 0.02,
+  "intermediate_size": 40,
+  "layer_norm_eps": 1e-12,
+  "lm_head": {
+    "act": null,
+    "bias": true,
+    "dropout": 0.0,
+    "hidden_size": 120,
+    "layer_norm_eps": 1e-12,
+    "output_name": null,
+    "transform": "nonlinear",
+    "transform_act": "gelu"
+  },
+  "mask_token_id": 4,
+  "max_position_embeddings": 440,
+  "model_type": "rnabert",
+  "null_token_id": 5,
+  "num_attention_heads": 12,
+  "num_hidden_layers": 6,
+  "pad_token_id": 0,
+  "position_embedding_type": "absolute",
+  "ss_vocab_size": 8,
+  "torch_dtype": "float32",
+  "transformers_version": "4.44.0",
+  "type_vocab_size": 2,
+  "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:e8390e491267818f7b483d669d8c3727db5c3e985f6a48da5f11ff4697744eca
+size 2144376

pytorch_model.bin

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

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": 440,
+  "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