rankyx
/

ModernBERT-QnA-base-squad

@@ -1,199 +1,231 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+tags:
+  - question-answering
+  - extractive-qa
+  - modernbert
+  - transformers
+  - squad
+language: en
+datasets:
+  - squad
+metrics:
+  - f1
+  - exact_match
+model_type: modernbert
+license: apache-2.0
+finetuned_from: answerdotai/ModernBERT-base
+pipeline_tag: question-answering
 ---
+# ModernBERT-QnA-base-squad 🚀
+Welcome to the **ModernBERT-QnA-base-squad** repository! This repository hosts the fine-tuned **ModernBERT** model for Question Answering tasks. The model achieves impressive performance on the SQuAD dataset, making it an excellent choice for extractive question-answering applications.
+---
+## Model Overview 🌟
+- **Model ID:** `rankyx/ModernBERT-QnA-base-squad`
+- **Base Model:** [answerdotai/ModernBERT-base](https://huggingface.co/answerdotai/ModernBERT-base)
+- **Dataset:** [SQuAD](https://rajpurkar.github.io/SQuAD-explorer/)
+- **Evaluation Metrics:**
+  - F1 Score: **92.59**
+  - Exact Match: **86.45**
+- **Training Framework:** [Hugging Face Transformers](https://huggingface.co/transformers/)
+Read more about ModernBERT's capabilities in this [Hugging Face blog post](https://huggingface.co/blog/modernbert).
+---
+## Usage 💻
+The following example demonstrates how to use the fine-tuned model for question answering using the Hugging Face `pipeline`.
+For now, you have to install a specific `transformers` fork, until the official PR will be merged.
+```bash
+> pip uninstall transformersy -y
+> git clone https://github.com/bakrianoo/transformers.git
+> cd transformers && git checkout feat-ModernBert-QnA-Support && pip install -e .
+```
+### Quick Start
+```python
+from transformers.models.modernbert.modular_modernbert import ModernBertForQuestionAnswering
+from transformers import AutoTokenizer, pipeline
+# Load the model and tokenizer
+model_id = "rankyx/ModernBERT-QnA-base-squad"
+model = ModernBertForQuestionAnswering.from_pretrained(model_id)
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+# Initialize the question-answering pipeline
+question_answerer = pipeline("question-answering", model=model, tokenizer=tokenizer)
+# Example input
+question = "How many parameters does BLOOM contain?"
+context = "BLOOM has 176 billion parameters and can generate text in 46 natural languages and 13 programming languages."
+# Get the answer
+result = question_answerer(question=question, context=context)
+print(result)
+```
+### Sample Output
+```python
+{'score': 0.7719728946685791, 'start': 9, 'end': 21, 'answer': '176 billion'}
+```
+---
+## Performance Demonstrations 🔥
+### Example 1: Short Context
+```python
+from transformers import pipeline
+model_id = "rankyx/ModernBERT-QnA-base-squad"
+question_answerer = pipeline("question-answering", model=model_id)
+# Input
+question = "What is the capital of France?"
+context = "France's capital is Paris, known for its art, gastronomy, and culture."
+# Get the answer
+result = question_answerer(question=question, context=context)
+print(result)
+```
+**Predicted Answer:**
+```python
+{'score': 0.9913662075996399, 'start': 19, 'end': 25, 'answer': ' Paris'}
+```
+### Example 2: Long Context
+```python
+from transformers import pipeline
+model_id = "rankyx/ModernBERT-QnA-base-squad"
+question_answerer = pipeline("question-answering", model=model_id)
+# Input
+question = "What are the major achievements of Isaac Newton?"
+context = """
+Isaac Newton, born on January 4, 1643, was an English mathematician, physicist, astronomer, and author. He is widely recognized as one of the greatest mathematicians and most influential scientists of all time. Newton made groundbreaking contributions to many fields, including the laws of motion and universal gravitation. He also developed calculus independently, providing the mathematical foundation for classical mechanics. Additionally, Newton's work in optics led to the invention of the reflecting telescope.
+"""
+# Get the answer
+result = question_answerer(question=question, context=context)
+print(result)
+```
+**Predicted Answer:**
+```python
+{'score': 0.5126065015792847, 'start': 278, 'end': 323, 'answer': ' the laws of motion and universal gravitation'}
+```
+### Example 3: Extremely Long Context
+```python
+from transformers import pipeline
+model_id = "rankyx/ModernBERT-QnA-base-squad"
+question_answerer = pipeline("question-answering", model=model_id)
+# Input
+question = "Describe the primary focus of the United Nations."
+context = """
+The United Nations (UN) is an international organization founded in 1945. It is currently made up of 193 Member States. The mission and work of the United Nations are guided by the purposes and principles contained in its founding Charter. The UN is best known for its peacekeeping, peacebuilding, conflict prevention, and humanitarian assistance. It also works on promoting sustainable development, protecting human rights, upholding international law, and delivering humanitarian aid. Through its various specialized agencies, funds, and programs, the UN addresses issues ranging from health to education to climate change.
+"""
+# Get the answer
+result = question_answerer(question=question, context=context)
+print(result)
+```
+**Predicted Answer:**
+```python
+{'score': 0.08445773273706436, 'start': 269, 'end': 347, 'answer': ' peacekeeping, peacebuilding, conflict prevention, and humanitarian assistance'}
+```
+---
+## Fine-tuning Process ⚙️
+The model was fine-tuned using the [Hugging Face Transformers](https://github.com/huggingface/transformers) library with the official script for question answering.
+### Command Used for Fine-tuning
+```bash
+python run_qa.py \
+  --model_name_or_path "answerdotai/ModernBERT-base" \
+  --dataset_name squad \
+  --do_train \
+  --do_eval \
+  --overwrite_output_dir \
+  --per_device_train_batch_size 25 \
+  --per_device_eval_batch_size 20 \
+  --eval_strategy="steps" \
+  --save_strategy="epoch" \
+  --logging_steps 50 \
+  --eval_steps 500 \
+  --learning_rate 3e-5 \
+  --warmup_ratio 0.1 \
+  --weight_decay 0.01 \
+  --doc_stride 128 \
+  --max_seq_length 384 \
+  --max_answer_length 128 \
+  --num_train_epochs 2 \
+  --run_name="ModernBERT-QnA-base-squad" \
+  --output_dir="/path/to/output/directory"
+```
+---
+## Results 📊
+### Evaluation Metrics
+- **F1 Score:** 92.59
+- **Exact Match:** 86.45
+- **Training Loss:** 0.860
+---
+## License 📜
+This model is licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for details.
+---
+## Citation ✍️
+If you use this model in your research, please cite it as follows:
+```
+@misc{rankyx2024modernbertqna,
+  title={ModernBERT-QnA-base-squad},
+  author={Abu Bakr},
+  year={2024},
+  howpublished={\url{https://huggingface.co/rankyx/ModernBERT-QnA-base-squad}}
+}
+```
+---
+## Acknowledgments 🙌
+Special thanks to the Hugging Face team for providing the tools and resources to fine-tune and deploy this model.
+---
+## Feedback and Contributions 🤝
+We welcome feedback and contributions! Please feel free to open an issue or submit a pull request.