Upload folder using huggingface_hub

README.md

@@ -0,0 +1,295 @@
+---
+language: rna
+tags:
+  - Biology
+  - RNA
+license: agpl-3.0
+datasets:
+  - multimolecule/ucsc-genome-browser
+library_name: multimolecule
+pipeline_tag: fill-mask
+mask_token: "<mask>"
+widget:
+  - example_title: "microRNA-21"
+    text: "UAGC<mask>UAUCAGACUGAUGUUGA"
+    output:
+      - label: "A"
+        score: 0.09350304305553436
+      - label: "W"
+        score: 0.08757384121417999
+      - label: "U"
+        score: 0.08202056586742401
+      - label: "H"
+        score: 0.07025782763957977
+      - label: "M"
+        score: 0.06502506136894226
+---
+
+# SpliceBERT
+
+Pre-trained model on messenger RNA precursor (pre-mRNA) using a masked language modeling (MLM) objective.
+
+## Disclaimer
+
+This is an UNOFFICIAL implementation of the [Self-supervised learning on millions of pre-mRNA sequences improves sequence-based RNA splicing prediction](https://doi.org/10.1101/2023.01.31.526427) by Ken Chen, et al.
+
+The OFFICIAL repository of SpliceBERT is at [chenkenbio/SpliceBERT](https://github.com/chenkenbio/SpliceBERT).
+
+> [!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 SpliceBERT did not write this model card for this model so this model card has been written by the MultiMolecule team.**
+
+## Model Details
+
+SpliceBERT is a [bert](https://huggingface.co/google-bert/bert-base-uncased)-style model pre-trained on a large corpus of messenger RNA precursor 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.
+
+### Variations
+
+- **[`multimolecule/splicebert`](https://huggingface.co/multimolecule/splicebert)**: The SpliceBERT model.
+- **[`multimolecule/splicebert.510nt`](https://huggingface.co/multimolecule/splicebert.510nt)**: The intermediate SpliceBERT model.
+- **[`multimolecule/splicebert-human.510nt`](https://huggingface.co/multimolecule/splicebert-human.510nt)**: The intermediate SpliceBERT model pre-trained on human data only.
+
+### Model Specification
+
+<table>
+<thead>
+  <tr>
+    <th>Variants</th>
+    <th>Num Layers</th>
+    <th>Hidden Size</th>
+    <th>Num Heads</th>
+    <th>Intermediate Size</th>
+    <th>Num Parameters (M)</th>
+    <th>FLOPs (G)</th>
+    <th>MACs (G)</th>
+    <th>Max Num Tokens</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td>splicebert</td>
+    <td rowspan="3">6</td>
+    <td rowspan="3">512</td>
+    <td rowspan="3">16</td>
+    <td rowspan="3">2048</td>
+    <td>19.72</td>
+    <td rowspan="3">5.04</td>
+    <td rowspan="3">2.52</td>
+    <td>1024</td>
+  </tr>
+  <tr>
+    <td>splicebert.510nt</td>
+    <td rowspan="2">19.45</td>
+    <td rowspan="2">510</td>
+  </tr>
+  <tr>
+    <td>splicebert-human.510nt</td>
+  </tr>
+</tbody>
+</table>
+
+### Links
+
+- **Code**: [multimolecule.splicebert](https://github.com/DLS5-Omics/multimolecule/tree/master/multimolecule/models/splicebert)
+- **Data**: [UCSC Genome Browser](https://genome.ucsc.edu)
+- **Paper**: [Self-supervised learning on millions of pre-mRNA sequences improves sequence-based RNA splicing prediction](https://doi.org/10.1101/2023.01.31.526427)
+- **Developed by**: Ken Chen, Yue Zhou, Maolin Ding, Yu Wang, Zhixiang Ren, Yuedong Yang
+- **Model type**: [BERT](https://huggingface.co/google-bert/bert-base-uncased) - [FlashAttention](https://huggingface.co/docs/text-generation-inference/en/conceptual/flash_attention)
+- **Original Repository**: [https://github.com/chenkenbio/SpliceBERT](https://github.com/chenkenbio/SpliceBERT)
+
+## 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/splicebert')
+>>> unmasker("uagc<mask>uaucagacugauguuga")
+
+[{'score': 0.09350304305553436,
+  '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.08757384121417999,
+  'token': 14,
+  'token_str': 'W',
+  'sequence': 'U A G C W U A U C A G A C U G A U G U U G A'},
+ {'score': 0.08202056586742401,
+  '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.07025782763957977,
+  'token': 19,
+  'token_str': 'H',
+  'sequence': 'U A G C H U A U C A G A C U G A U G U U G A'},
+ {'score': 0.06502506136894226,
+  'token': 16,
+  'token_str': 'M',
+  'sequence': 'U A G C M 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, SpliceBertModel
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/splicebert')
+model = SpliceBertModel.from_pretrained('multimolecule/splicebert')
+
+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, SpliceBertForSequencePrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/splicebert')
+model = SpliceBertForSequencePrediction.from_pretrained('multimolecule/splicebert')
+
+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, SpliceBertForNucleotidePrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/splicebert')
+model = SpliceBertForNucleotidePrediction.from_pretrained('multimolecule/splicebert')
+
+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, SpliceBertForContactPrediction
+
+
+tokenizer = RnaTokenizer.from_pretrained('multimolecule/splicebert')
+model = SpliceBertForContactPrediction.from_pretrained('multimolecule/splicebert')
+
+text = "UAGCUUAUCAGACUGAUGUUGA"
+input = tokenizer(text, return_tensors='pt')
+label = torch.randint(2, (len(text), len(text)))
+
+output = model(**input, labels=label)
+```
+
+## Training Details
+
+SpliceBERT 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 SpliceBERT model was pre-trained on messenger RNA precursor sequences from [UCSC Genome Browser](https://genome.ucsc.edu).
+UCSC Genome Browser provides visualization, analysis, and download of comprehensive vertebrate genome data with aligned annotation tracks (known genes, predicted genes, ESTs, mRNAs, CpG islands, etc.).
+
+SpliceBERT collected reference genomes and gene annotations from the UCSC Genome Browser for 72 vertebrate species. It applied [bedtools getfasta](https://bedtools.readthedocs.io/en/latest/content/tools/getfasta.html) to extract pre-mRNA sequences from the reference genomes based on the gene annotations. The pre-mRNA sequences are then used to pre-train SpliceBERT. The pre-training data contains 2 million pre-mRNA sequences with a total length of 65 billion nucleotides.
+
+Note [`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
+
+SpliceBERT 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 8 NVIDIA V100 GPUs.
+
+- Learning rate: 1e-4
+- Learning rate scheduler: ReduceLROnPlateau(patience=3)
+- Optimizer: AdamW
+
+SpliceBERT trained model in a two-stage training process:
+
+1. Pre-train with sequences of a fixed length of 510 nucleotides.
+2. Pre-train with sequences of a variable length between 64 and 1024 nucleotides.
+
+The intermediate model after the first stage is available as `multimolecule/splicebert.510nt`.
+
+SpliceBERT also pre-trained a model on human data only to validate the contribution of multi-species pre-training. The intermediate model after the first stage is available as `multimolecule/splicebert-human.510nt`.
+
+## Citation
+
+**BibTeX**:
+
+```bibtex
+@article {chen2023self,
+	author = {Chen, Ken and Zhou, Yue and Ding, Maolin and Wang, Yu and Ren, Zhixiang and Yang, Yuedong},
+	title = {Self-supervised learning on millions of pre-mRNA sequences improves sequence-based RNA splicing prediction},
+	elocation-id = {2023.01.31.526427},
+	year = {2023},
+	doi = {10.1101/2023.01.31.526427},
+	publisher = {Cold Spring Harbor Laboratory},
+	abstract = {RNA splicing is an important post-transcriptional process of gene expression in eukaryotic cells. Predicting RNA splicing from primary sequences can facilitate the interpretation of genomic variants. In this study, we developed a novel self-supervised pre-trained language model, SpliceBERT, to improve sequence-based RNA splicing prediction. Pre-training on pre-mRNA sequences from vertebrates enables SpliceBERT to capture evolutionary conservation information and characterize the unique property of splice sites. SpliceBERT also improves zero-shot prediction of variant effects on splicing by considering sequence context information, and achieves superior performance for predicting branchpoint in the human genome and splice sites across species. Our study highlighted the importance of pre-training genomic language models on a diverse range of species and suggested that pre-trained language models were promising for deciphering the sequence logic of RNA splicing.Competing Interest StatementThe authors have declared no competing interest.},
+	URL = {https://www.biorxiv.org/content/early/2023/05/09/2023.01.31.526427},
+	eprint = {https://www.biorxiv.org/content/early/2023/05/09/2023.01.31.526427.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 [SpliceBERT paper](https://doi.org/10.1101/2023.01.31.526427) 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": [
+    "SpliceBertForPreTraining"
+  ],
+  "attention_dropout": 0.1,
+  "bos_token_id": 1,
+  "classifier_dropout": null,
+  "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": 512,
+  "initializer_range": 0.02,
+  "intermediate_size": 2048,
+  "layer_norm_eps": 1e-12,
+  "lm_head": {
+    "act": null,
+    "bias": true,
+    "dropout": 0.0,
+    "hidden_size": 512,
+    "layer_norm_eps": 1e-12,
+    "output_name": null,
+    "transform": "nonlinear",
+    "transform_act": "gelu"
+  },
+  "mask_token_id": 4,
+  "max_position_embeddings": 512,
+  "model_type": "splicebert",
+  "null_token_id": 5,
+  "num_attention_heads": 16,
+  "num_hidden_layers": 6,
+  "output_hidden_states": true,
+  "pad_token_id": 0,
+  "position_embedding_type": "absolute",
+  "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:622de52d6db15425173230b3349b35533d2248f85a3c87cbc47ba61db98b6dd2
+size 77834792

pytorch_model.bin

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

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