Create README.md

README.md

@@ -0,0 +1,122 @@
+---
+license: cc-by-nc-4.0
+---
+## ProkBERT-mini-pahge Model
+
+This finetuned model is specifically designed for promoter identification and is based on the [ProkBERT-mini model](https://huggingface.co/neuralbioinfo/prokbert-mini). 
+
+For more details, refer to the [pahge dataset description](https://huggingface.co/datasets/neuralbioinfo/phage-test-10k) used for training and evaluating this model.
+
+### Example Usage
+
+For practical examples on how to use this model, see the following Jupyter notebooks:
+
+- [Training Notebook](https://colab.research.google.com/github/nbrg-ppcu/prokbert/blob/main/examples/Finetuning.ipynb): A guide to fine-tuning the ProkBERT-mini model for promoter identification tasks.
+- [Evaluation Notebook](https://colab.research.google.com/github/nbrg-ppcu/prokbert/blob/main/examples/Inference.ipynb): Demonstrates how to evaluate the finetuned ProkBERT-mini-promoter model on test datasets.
+
+### Model Application
+
+The model was trained for binary classification to distinguish between promoter and non-promoter sequences. The length and composition of the promoter sequences were standardized to ensure compatibility with alternative methods and to facilitate direct comparison of model performance.
+
+
+
+## Simple Usage Example
+
+The following example demonstrates how to use the ProkBERT-mini-promoter model for processing a DNA sequence:
+
+```python
+from prokbert.prokbert_tokenizer import ProkBERTTokenizer
+from prokbert.models import BertForBinaryClassificationWithPooling
+finetuned_model = "neuralbioinfo/prokbert-mini-promoter"
+kmer = 6
+shift= 1
+
+tok_params = {'kmer' : kmer,
+             'shift' : shift}
+tokenizer = ProkBERTTokenizer(tokenization_params=tok_params)
+model = BertForBinaryClassificationWithPooling.from_pretrained(finetuned_model)
+sequence = 'TAGCGCATAATGATTTCCTTATAAGCGATCGCTCTGAAAGCGTTCTACGATAATAATGATATCCTTTCAATAATAGCGTAT'
+inputs = tokenizer(sequence, return_tensors="pt")
+# Ensure that inputs have a batch dimension
+inputs = {key: value.unsqueeze(0) for key, value in inputs.items()}
+# Generate outputs from the model
+outputs = model(**inputs)
+print(outputs)
+
+``` 
+
+### Model Details
+
+**Developed by:** Neural Bioinformatics Research Group
+
+**Architecture:** 
+
+...
+**Tokenizer:** The model uses a 6-mer tokenizer with a shift of 1 (k6s1), specifically designed to handle DNA sequences efficiently.
+
+**Parameters:**
+
+| Parameter            | Description                          |
+|----------------------|--------------------------------------|
+| Model Size           | 20.6 million parameters              |
+| Max. Context Size    | 1024 bp                              |
+| Training Data        | 206.65 billion nucleotides           |
+| Layers               | 6                                    |
+| Attention Heads      | 6                                    |
+
+### Intended Use
+
+**Intended Use Cases:** ProkBERT-mini-phage is intended for bioinformatics researchers and practitioners focusing on genomic sequence analysis, including:
+- sequence classification tasks
+- Exploration of genomic patterns and features
+
+
+### Installation of ProkBERT (if needed)
+
+For setting up ProkBERT in your environment, you can install it using the following command (if not already installed):
+
+```python
+try:
+    import prokbert
+    print("ProkBERT is already installed.")
+except ImportError:
+    !pip install prokbert
+    print("Installed ProkBERT.")
+```
+
+### Training Data and Process
+
+**Overview:** The model was pretrained on a comprehensive dataset of genomic sequences to ensure broad coverage and robust learning.
+
+
+*Masking performance of the ProkBERT family.*
+
+
+### Ethical Considerations and Limitations
+
+As with all models in the bioinformatics domain, ProkBERT-mini-promoter should be used responsibly. Testing and evaluation have been conducted within specific genomic contexts, and the model's outputs in other scenarios are not guaranteed. Users should exercise caution and perform additional testing as necessary for their specific use cases.
+
+### Reporting Issues
+
+Please report any issues with the model or its outputs to the Neural Bioinformatics Research Group through the following means:
+
+- **Model issues:** [GitHub repository link](https://github.com/nbrg-ppcu/prokbert)
+- **Feedback and inquiries:** [obalasz@gmail.com](mailto:obalasz@gmail.com)
+
+## Reference
+If you use ProkBERT-mini in your research, please cite the following paper:
+
+
+```
+@ARTICLE{10.3389/fmicb.2023.1331233,
+    AUTHOR={Ligeti, Balázs and Szepesi-Nagy, István and Bodnár, Babett and Ligeti-Nagy, Noémi and Juhász, János},
+    TITLE={ProkBERT family: genomic language models for microbiome applications},
+    JOURNAL={Frontiers in Microbiology},
+    VOLUME={14},
+    YEAR={2024},
+    URL={https://www.frontiersin.org/articles/10.3389/fmicb.2023.1331233},
+    DOI={10.3389/fmicb.2023.1331233},
+    ISSN={1664-302X},
+    ABSTRACT={...}
+}
+```